Die Neo Dokumentation und Homepage mit MkDocs.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

56 lines
2.6 KiB

<h1 align="center">
<a href="https://neo-layout.org" style="padding: 0;">
Neo - ergonomisch optimiert
</a><br />
<span style="font-size: .8rem; display: block;">Dokumentation</span>
</h1>
## Änderungen direkt Über gitea
9 months ago
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.
## 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 irgendeiner Form
### Herunterladen
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
```
### 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 aktuallisiert.
Mittels `mkdocs build` 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 Startseitentemplates
│ └─ kontakt.md # Kontaktseite
├─ overrides/ # Themaanpassungen nach Materialvorgabe
│ ├─ assets/
12 months ago
│ │ ├─ images/ # Icons, Logos und Bilder für die Startseite
│ │ └─ stylesheets/ # Zusätzliche Stilanpassungen
│ ├─ overrides/
│ │ └─ home.html # Startseitentemplate
│ ├─ partials/
│ │ ├─ footer.html # Anpassung des Footers
12 months ago
│ │ ├─ 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
```