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.

55 lines
2.6 KiB

12 months ago
4 months ago
12 months ago
6 months ago
12 months ago
12 months ago
6 months ago
  1. <h1 align="center">
  2. <a href="https://neo-layout.org" style="padding: 0;">
  3. Neo - ergonomisch optimiert
  4. </a><br />
  5. <span style="font-size: .8rem; display: block;">Dokumentation</span>
  6. </h1>
  7. ## Änderungen direkt Über gitea
  8. 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.
  9. ## Selber bauen
  10. ### Anforderungen
  11. * [MkDocs](https://www.mkdocs.org) - Statischer Seiten Generator
  12. * [MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) - Material Thema für MkDocs
  13. * Git in irgendeiner Form
  14. ### Herunterladen
  15. Das [Dokumentations Repo](https://git.neo-layout.org/neo/dokumentation) herunterladen und entpacken oder mittels Befehl klonen:
  16. ```
  17. git clone https://git.neo-layout.org/neo/dokumentation.git
  18. ```
  19. ### Bauen
  20. 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.
  21. Mittels `mkdocs build` kann die gesamte Dokumentation statisch generiert werden. Die entstandenen Dateien finden sich im Verzeichnis `site`.
  22. ## Struktur
  23. ```
  24. .
  25. ├─ docs/ # Dokumentationsstexte im Markdownformat
  26. │ ├─ Quickguide/ # Markdown für Download und Installation
  27. │ ├─ Benutzerhandbuch/ # Seiten zum Benutzerhandbuch
  28. │ ├─ .../ # und andere bereiche der Dokumentation
  29. │ ├─ index.md # Setzen des Startzeitentemplates
  30. │ └─ kontakt.md # Kontaktseite
  31. ├─ overrides/ # Themaanpassungen nach Materialvorgabe
  32. │ ├─ assets/
  33. │ │ ├─ images/ # Icons, Logos und Bilder für die Startseite
  34. │ │ └─ stylesheets/ # Zusätzliche Stilanpassungen
  35. │ ├─ overrides/
  36. │ │ └─ home.html # Startseitentemplate
  37. │ ├─ partials/
  38. │ │ ├─ footer.html # Anpassung des Footers
  39. │ │ ├─ tabs-item.html # Anpassung der Tabbar um Tabs mit Einzelseiten zu erlauben
  40. │ │ └─ header.html # Anpassung des Headers
  41. │ └─ main.html # Anpassung des Haupttemplates
  42. ├─ mkdocs.yml # MkDocs Konfiguration
  43. └─ README.md
  44. ```