forked from neo/dokumentation
58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
|
---
|
||
|
|
template: main.html
|
||
|
|
---
|
||
|
|
<h1 align="center">
|
||
|
|
<a href="https://neo-layout.org" style="padding: 0;">
|
||
|
|
Neo - ergonomisch optimiert
|
||
|
|
</a>
|
||
|
|
<span style="font-size: .8rem; display: block;">Dokumentation</span>
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
## Änderungen direkt Über gitea
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Selber bauen
|
||
|
|
|
||
|
|
### Anforderungen
|
||
|
|
|
||
|
|
* [MkDocs](https://www.mkdocs.org) - Statischer Seiten Generator
|
||
|
|
* [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) - Material Thema für MkDocs
|
||
|
|
* Git in irgend einer Form
|
||
|
|
|
||
|
|
### Herunterladen
|
||
|
|
Das [Dokumentations Repo](https://git.neo-layout.org/neo/dokumentation) herunterladen und entpacken oder mittels Befehl klonen.
|
||
|
|
|
||
|
|
ssh: `git clone neo@git.neo-layout.org:neo/dokumentation.git`
|
||
|
|
https: `git clone https://git.neo-layout.org/neo/dokumentation.git`
|
||
|
|
|
||
|
|
### Bauen
|
||
|
|
Den lokalen MkDocs Server im Dokumentations Ropo mit `mkdocs serve` starten. Die Dokumentation wird nun auf `http://localhost:8000` angezeigt und bei Änderungen automatisch aktuallisiert.
|
||
|
|
|
||
|
|
Mittels `mkdocs bulld` kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis `/site`.
|
||
|
|
|
||
|
|
## Struktur
|
||
|
|
|
||
|
|
```
|
||
|
|
.
|
||
|
|
├─ docs/ # Dokumentationsstexte im Markdownformat
|
||
|
|
│ ├─ Quickguide/ # Markdown für Download und Installation
|
||
|
|
│ ├─ Benutzerhandbuch/ # Seiten zum Benutzerhandbuch
|
||
|
|
│ ├─ .../ # und andere bereiche der Dokumentation
|
||
|
|
│ ├─ index.md # Setzen des Startzeitentemplates
|
||
|
|
│ └─ kontakt.md # Kontaktseite
|
||
|
|
├─ overrides/ # Themaanpassungen nach Materialvorgabe
|
||
|
|
│ ├─ assets
|
||
|
|
│ │ ├─ images # Icons, Logos und Tastaturbilder
|
||
|
|
│ │ └─ stylesheets # Zusätzliche Stilanpassungen
|
||
|
|
│ ├─ overrides
|
||
|
|
│ │ └─ home.html # Startseitentemplate
|
||
|
|
│ ├─ partials
|
||
|
|
│ │ ├─ footer.html # Anpassung des Footers
|
||
|
|
│ │ └─ header.html # Anpassung des Headers
|
||
|
|
│ └─ main.html # Anpassung des Haupttemplates
|
||
|
|
├─ mkdocs.yml # MkDocs Konfiguration
|
||
|
|
└─ README.md
|
||
|
|
```
|