Das komplette Neo-Wiki, was auch die Homepage darstellt. Gemacht mit ♥ und MkDocs.
Go to file
Ulli Kehrle f1741c68de
Varianten fertig?
2021-01-15 03:01:03 +01:00
docs Varianten fertig? 2021-01-15 03:01:03 +01:00
overrides whitespace fix 2021-01-14 22:42:20 +01:00
.gitignore ignore venv 2021-01-13 04:57:52 +01:00
README.md adjust README 2020-11-13 15:38:44 +01:00
mkdocs.yml Layouts-Übersichtsseite angepasst 2021-01-15 02:09:13 +01: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://mkdocs.neo.uber.space/ 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 Ropo 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 Startzeitentemplates
│  └─ 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