Skip to content

Commit a8e7b20

Browse files
Add home
1 parent a2ba308 commit a8e7b20

24 files changed

Lines changed: 360 additions & 74 deletions

.github/workflows/main.yml

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,12 @@ jobs:
4141
pip install -U pip
4242
pip install -r requirements.txt
4343
44-
- name: Build BlackSheep documentation
44+
- name: Build and pack docs
4545
run: |
46-
cd blacksheep
47-
mkdocs build
48-
49-
- name: Zip built files
50-
run: |
51-
cd blacksheep
52-
mkdir -p .build/blacksheep
53-
mv site/* .build/blacksheep
54-
cd .build
55-
7z a -r site.zip blacksheep
46+
./pack.sh
5647
5748
- name: Upload distribution package
5849
uses: actions/upload-artifact@v4
5950
with:
6051
name: dist
61-
path: .build/site.zip
52+
path: site.zip

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ site
22
venv
33
.build
44
.env
5+
site.zip
56

67
# temporary
78
rodi

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,18 @@ documentation.
1818
```bash
1919
$ mkdocs serve
2020
```
21+
22+
## How to build the full site
23+
24+
- Create a Python virtual environment, activate, install the dependencies.
25+
- Use `pack.sh` to build the full site.
26+
- `cd` into the generated `site` folder.
27+
- Start a dev servers. Recommended: use `Python http.server` module.
28+
29+
```bash
30+
./pack.sh
31+
32+
cd site
33+
34+
python3.13 -m http.server 44777
35+
```

blacksheep/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# BlackSheep docs 📜
2+
3+
[www.neoteroi.dev](https://www.neoteroi.dev/blacksheep/).

blacksheep/mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,10 @@ extra_css:
8585

8686
plugins:
8787
- search
88-
- neoteroi.contribs
88+
- neoteroi.contribs:
89+
contributors:
90+
- email: roberto.prevato@gmail.com
91+
image: https://avatars.githubusercontent.com/u/2576032?s=400&u=d8d880e8ed05bb170877dd3d561d8301c4beeeed&v=4
8992

9093
markdown_extensions:
9194
- admonition

home/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Neoteroi-docs-home
2+
3+
Source code for the homepage of [www.neoteroi.dev](https://www.neoteroi.dev).

home/docs/css/extra.css

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
html {
2+
overflow-y: scroll;
3+
}
4+
5+
:root,
6+
[data-md-color-scheme=default],
7+
[data-md-color-scheme=slate] {
8+
--md-primary-fg-color: #00435c;
9+
--md-footer-bg-color: #00435c;
10+
}
11+
12+
[data-md-color-scheme=slate] a {
13+
--md-primary-fg-color: #76e4af;
14+
--md-typeset-a-color: #76e4af;
15+
}
16+
17+
[data-md-color-scheme=slate] a:hover {
18+
--md-accent-fg-color: #fe5252;
19+
}
20+
21+
[data-md-color-scheme=slate] a:hover {
22+
--md-accent-fg-color: #5cd9b6;
23+
}
24+
25+
26+
.epic-timeline .nt-timeline-dot .icon {
27+
color: white;
28+
background: white;
29+
border-radius: 50%;
30+
}
31+
32+
#icons-credits>div {
33+
max-width: 59rem;
34+
margin: auto;
35+
padding: .3rem;
36+
}
37+
38+
.credits-note {
39+
font-style: italic;
40+
font-size: 0.7rem;
41+
}
42+
43+
.nt-card-image[style*="oad.png"],
44+
.nt-card-image[style*="spantable.png"] {
45+
background-position: top !important;
46+
}

home/docs/css/neoteroi.css

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

home/docs/img/blacksheep.png

183 KB
Loading

home/docs/img/favicon.ico

1.12 KB
Binary file not shown.

0 commit comments

Comments
 (0)