## Änderungen direkt über Gitea
Auf den Dokumentationsseiten befindet sich ein 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.
## Selber Bauen
### Anforderungen
* [MkDocs](https://www.mkdocs.org) – Statischer Seitengenerator
* [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) – Material-Theme für MkDocs
* Git in irgendeiner Form
### Herunterladen
Das [Dokumentations-Repository](https://git.neo-layout.org/neo/dokumentation) herunterladen und entpacken oder mittels Befehl klonen:
```
git clone https://git.neo-layout.org/neo/dokumentation.git
```
Das Produktivsystem verwendet zur Zeit Version 7.2.1 von mkdocs-material. Eine kompatible Testumgebung kann man mit
```
python -m venv venv
./venv/bin/activate
pip install -r requirements.txt
```
aufsetzen.
### Bauen
Den lokalen MkDocs Server im Dokumentations-Repository mit `mkdocs serve` starten. Die Dokumentation wird nun auf `http://localhost:8000` angezeigt und bei Änderungen automatisch aktualisiert.
Mittels `mkdocs build` kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis `site`.
## Struktur
```
.
├─ docs/ # Dokumentationsstexte im Markdownformat
│ ├─ Einrichtung/ # Neo einrichten
│ ├─ Benutzerhandbuch/ # Einzelne Seiten zum Benutzerhandbuch
│ ├─ Beitragen/ # Kontakt, Mitmachen, Mitentwickeln
│ ├─ Download/ # Markdown für Download und Installation
│ ├─ .../ # und andere Bereiche der Dokumentation / des Benutzerhandbuchs
│ └─ index.md # Setzen des Startseitentemplates
├─ overrides/ # Themaanpassungen nach Materialvorgabe
│ ├─ assets/
│ │ ├─ images/ # Icons, Logos und Bilder für die Startseite
│ │ └─ stylesheets/ # Zusätzliche Stilanpassungen
│ ├─ overrides/
│ │ └─ home.html # Startseitentemplate
│ ├─ partials/
│ │ ├─ footer.html # Anpassung des Footers
│ │ ├─ tabs-item.html # Anpassung der Tabbar um Tabs mit Einzelseiten zu erlauben
│ │ └─ header.html # Anpassung des Headers
│ └─ main.html # Anpassung des Haupttemplates
├─ mkdocs.yml # MkDocs Konfiguration
└─ README.md
```