2020-05-22 18:38:05 +02:00
< h1 align = "center" >
< a href = "https://neo-layout.org" style = "padding: 0;" >
Neo - ergonomisch optimiert
2020-05-22 18:41:41 +02:00
< / a > < br / >
2020-05-22 18:38:05 +02:00
< span style = "font-size: .8rem; display: block;" > Dokumentation< / span >
< / h1 >
## Änderungen direkt Über gitea
2021-01-16 15:09:51 +01:00
Auf den Dokumentationsseiten befindet sich ein < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" width = "1em" > < path d = "M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z" > < / path > < / svg > Knopf, über den die Seite im Gitea Editor geändert werden kann. Die Dokumentation wird automatisch neu gebaut, wenn Änderungen im master branch eingehen und kann unter https://neo-layout.org/ eingesehen werden.
2020-05-22 18:38:05 +02:00
## Selber bauen
### Anforderungen
* [MkDocs ](https://www.mkdocs.org ) - Statischer Seiten Generator
* [MkDocs-Material ](https://squidfunk.github.io/mkdocs-material/ ) - Material Thema für MkDocs
2020-11-08 15:38:30 +01:00
* Git in irgendeiner Form
2020-05-22 18:38:05 +02:00
### Herunterladen
2020-11-08 15:38:30 +01:00
Das [Dokumentations Repo ](https://git.neo-layout.org/neo/dokumentation ) herunterladen und entpacken oder mittels Befehl klonen:
```
git clone https://git.neo-layout.org/neo/dokumentation.git
```
2020-05-22 18:38:05 +02:00
2021-05-12 02:37:42 +02:00
Das Produktivsystem verwendet zur Zeit Version 6.1.4 von mkdocs-material. Eine kompatible Testumgebung kann man mit
```
python -m venv venv
. venv/bin/activate
pip installl -r requirements.txt
```
aufsetzen.
2020-05-22 18:38:05 +02:00
### Bauen
2021-01-18 20:15:57 +01:00
Den lokalen MkDocs Server im Dokumentations-Repository mit `mkdocs serve` starten. Die Dokumentation wird nun auf `http://localhost:8000` angezeigt und bei Änderungen automatisch aktuallisiert.
2020-05-22 18:38:05 +02:00
2020-11-08 15:38:30 +01:00
Mittels `mkdocs build` kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis `site` .
2020-05-22 18:38:05 +02:00
## Struktur
```
.
├─ docs/ # Dokumentationsstexte im Markdownformat
│ ├─ Quickguide/ # Markdown für Download und Installation
│ ├─ Benutzerhandbuch/ # Seiten zum Benutzerhandbuch
│ ├─ .../ # und andere bereiche der Dokumentation
2021-01-18 18:02:32 +01:00
│ ├─ index.md # Setzen des Startseitentemplates
2020-05-22 18:38:05 +02:00
│ └─ kontakt.md # Kontaktseite
├─ overrides/ # Themaanpassungen nach Materialvorgabe
2020-05-22 18:41:41 +02:00
│ ├─ assets/
2020-11-13 15:19:44 +01:00
│ │ ├─ images/ # Icons, Logos und Bilder für die Startseite
2020-05-22 18:41:41 +02:00
│ │ └─ stylesheets/ # Zusätzliche Stilanpassungen
│ ├─ overrides/
2020-05-22 18:38:05 +02:00
│ │ └─ home.html # Startseitentemplate
2020-05-22 18:41:41 +02:00
│ ├─ partials/
2020-05-22 18:38:05 +02:00
│ │ ├─ footer.html # Anpassung des Footers
2020-11-13 15:19:44 +01:00
│ │ ├─ tabs-item.html # Anpassung der Tabbar um Tabs mit Einzelseiten zu erlauben
2020-05-22 18:38:05 +02:00
│ │ └─ header.html # Anpassung des Headers
│ └─ main.html # Anpassung des Haupttemplates
├─ mkdocs.yml # MkDocs Konfiguration
└─ README.md
```