Go to file

Ulli Kehrle c82c42ec13 Entferne Bilder aus Repo Die meisten Bilder sind nun auf https://dl.neo-layout.org/grafik vorhanden. Diese Bilder werden nun verlinkt anstatt ein zweites mal im Doku-Repo zu sein.		2021-04-27 01:29:44 +02:00
docs	Entferne Bilder aus Repo	2021-04-27 01:29:44 +02:00
overrides	Entferne Bilder aus Repo	2021-04-27 01:29:44 +02:00
snippets	Glossar in die FAQ eingefügt, Beschreibung der Notation von Tastenkombinationen	2021-02-08 22:01:46 +01:00
.gitignore	ignore venv	2021-01-13 04:57:52 +01:00
README.md	Merge https://git.neo-layout.org/chris/dokumentation	2021-01-18 20:15:57 +01:00
mkdocs.yml	Erbarmungslos den Mülleimer der Wikiseiten ausgeleert	2021-04-26 02:40:46 +02:00

README.md

Neo - ergonomisch optimiert
Dokumentation

Ä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 - Statischer Seiten Generator
MkDocs-Material - Material Thema für MkDocs
Git in irgendeiner Form

Herunterladen

Das Dokumentations Repo 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/
│  │  ├─ 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