Dokumentation lokal starten

Du kannst diese Dokumentation auf deinem eigenen Computer bearbeiten und eine Vorschau anzeigen, bevor du sie online stellst.

Voraussetzungen

Stelle sicher, dass du die Dokumentations-Tools installiert hast:

pip install -r requirements.txt

(Dies installiert mkdocs, mkdocs-material und die nötigen Erweiterungen).

Um die Dokumentation live während der Bearbeitung zu sehen: 1. Öffne ein Terminal im Projektverzeichnis. 2. Starte den MkDocs-Server:

mkdocs serve

3. Öffne deinen Browser unter http://127.0.0.1:8000.

Jede Änderung, die du an den .md-Dateien speicherst, wird sofort im Browser aktualisiert.

Um die fertigen HTML-Dateien für den Server zu erzeugen:

mkdocs build

Die Dateien liegen danach im Ordner site/.

Nutze das bereitgestellte Skript, um die Änderungen auf den Server zu laden:

python upload_manual.py

Dadurch wird der Inhalt von site/ nach public_html/manual/ListenWichtel übertragen.