jgosmann
/
dokumentation
forked from neo/dokumentation
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Das komplette Neo-Wiki, was auch die Homepage darstellt. Gemacht mit ♥ und MkDocs.
431 Commits 4 Branches 0 Tags 16 MiB
HTML 65.4%
CSS 27.3%
Scheme 7.3%
Go to file
Jan Gosmann 3b679a843f
Ergänze macOS Hinweise und Einschränkungen 
Dies ergänzt die Punkte, um die in der
[neo2-layout-osx readme](https://github.com/jgosmann/neo2-layout-osx#know-issues)
beschriebenen Punkte. Zudem habe ich zusammengehörige Punkte gegliedert,
um eine Bessere Übersicht zu erzeugen.

Den Link zu neo2-layout-osx habe ich entfernt, da damit alle relevanten
Informationen direkt in die Dokumentation integriert sein sollten und
ich vorhabe das Repository zu archivieren, da alle dortigen Änderungen
sich inzwischen auch im offiziellen Neo-Repository befinden.
 		2022-04-24 14:11:51 +02:00
docs Ergänze macOS Hinweise und Einschränkungen 2022-04-24 14:11:51 +02:00
overrides Vernünftige breitengleiche Schriftart für Code 2021-09-24 20:18:25 +02:00
snippets Glossar in die FAQ eingefügt, Beschreibung der Notation von Tastenkombinationen 2021-02-08 22:01:46 +01:00
.gitignore Ignoriere swp-Dateien 2022-04-24 14:09:22 +02:00
README.md Update 'README.md' 2021-07-27 21:02:00 +02:00
guix.scm Verwende spezifischen commit von guix 2021-05-12 07:41:01 +02:00
mkdocs.yml Linksymbol bei Überschriften geändert, Korrektur im Text 2021-10-21 00:43:39 +02:00
requirements.txt bump versions 2021-07-27 20:46:23 +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 Seitengenerator
  • MkDocs-Material – Material-Theme für MkDocs
  • Git in irgendeiner Form

Herunterladen

Das Dokumentations-Repository herunterladen und entpacken oder mittels Befehl klonen:

git clone https://git.neo-layout.org/neo/dokumentation.git

Das Produktivsystem verwendet zur Zeit Version 7.2.1 von mkdocs-material. Eine kompatible Testumgebung kann man mit

python -m venv venv
./venv/bin/activate
pip install -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 aktualisiert.

Mittels mkdocs build kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis site.

Struktur

.
├─ docs/                   # Dokumentationsstexte im Markdownformat
│  ├─ Einrichtung/         # Neo einrichten
│  ├─ Benutzerhandbuch/    # Einzelne Seiten zum Benutzerhandbuch
│  ├─ Beitragen/           # Kontakt, Mitmachen, Mitentwickeln
│  ├─ Download/            # Markdown für Download und Installation
│  ├─ .../                 # und andere Bereiche der Dokumentation / des Benutzerhandbuchs
│  └─ index.md             # Setzen des Startseitentemplates
├─ 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