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.
 
 
 
qwertfisch f050bc15ae Geschwindigkeitsrekorde rausgenommen, haben in der Dokumentation nichts verloren 6 months ago
docs Geschwindigkeitsrekorde rausgenommen, haben in der Dokumentation nichts verloren 6 months ago
overrides Korrektur Link sowie Tippfehler 7 months ago
snippets Glossar in die FAQ eingefügt, Beschreibung der Notation von Tastenkombinationen 10 months ago
.gitignore ignore venv 11 months ago
README.md Kompatible Abhängigkeiten hinzugefügt 7 months ago
guix.scm Verwende spezifischen commit von guix 7 months ago
mkdocs.yml Merge branch 'master' of https://git.neo-layout.org/neo/dokumentation 7 months ago
requirements.txt Kompatible Abhängigkeiten hinzugefügt 7 months ago

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

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.

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