Skip to content
mandariOSSPublic

About

Dokumentation der mandari-Plattform – docs.mandari.de (MkDocs Material)

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

mandari Dokumentation

Quelltext der Dokumentation unter https://docs.mandari.de – gebaut mit MkDocs und Material for MkDocs.

Lokal arbeiten

python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -r requirements.txt
mkdocs serve          # http://127.0.0.1:8000 mit Live-Reload
mkdocs build --strict # wie in CI

Struktur

Pfad Inhalt
docs/ Inhalte als Markdown, gegliedert nach Insight, Work, Session, Betrieb, Datenschutz, Entwicklung
mkdocs.yml Navigation, Theme, Plugins
overrides/ Template-Anpassungen (Meta-Tags, 404-Seite)
Dockerfile, nginx.conf Produktions-Image: statischer Build hinter unprivilegiertem nginx
docs/llms.txt Übersicht für Sprachmodelle nach llmstxt.org, neue Seiten hier eintragen
tests/ CI-Prüfungen: llms.txt und Antworten des nginx-Containers (Doku-Seiten, Weiterleitungen auf mandari.de); dazu umgebungsvariablen.py, das die Konfigurationsreferenz gegen einen Checkout von mandariOSS/mandari abgleicht
.github/workflows/ CI (strikter Build, Link-Check, llms.txt, Container-Test) und Release (Image nach GHCR)

Beitragen

Jede Seite hat oben rechts einen Bearbeiten-Stift, der direkt zur Datei auf GitHub führt. Tippfehler, Ergänzungen und neue Anleitungen sind als Pull Request willkommen. Bitte mkdocs build --strict vor dem Einreichen laufen lassen – defekte Links lassen den Build fehlschlagen.

Lizenz

Inhalte: CC BY 4.0. Build-Code: MIT. Details in LICENSE.

About

Dokumentation der mandari-Plattform – docs.mandari.de (MkDocs Material)

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages