trs/IT-Doku_Vorlage
Template
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Vorlage für den Unterricht IT-Dokumentation.
2 commits 1 branch 0 tags 32 KiB
Find a file Use this template
Exact
Constantin Tress c0d4e8a5c9 Add initial documentation and configuration files for IT-Doku project
2026-11-09 22:15:28 +01:00
docs Add initial documentation and configuration files for IT-Doku project 2026-11-09 22:15:28 +01:00
.gitignore Initial commit 2026-11-09 20:51:13 +01:00
compose.yaml Add initial documentation and configuration files for IT-Doku project 2026-11-09 22:15:28 +01:00
README.md Add initial documentation and configuration files for IT-Doku project 2026-11-09 22:15:28 +01:00
zensical.toml Add initial documentation and configuration files for IT-Doku project 2026-11-09 22:15:28 +01:00

README.md

IT-Doku

Vorlage für eine IT-Dokumentation mit Git, Markdown und Zensical. Die Inhalte liegen als Markdown-Dateien im Ordner docs/.

Vorschau starten

Voraussetzung sind Podman und Podman Compose. Starten Sie im Repository-Verzeichnis den Zensical-Dienst:

podman-compose up -d

Die Vorschau ist anschließend unter http://localhost:8000 erreichbar. Änderungen an den Markdown-Dateien werden automatisch neu geladen.

Website erstellen

Erzeugen Sie die statische Website mit:

podman-compose run --rm zensical build

Die erzeugten Dateien liegen im Ordner site/. Beenden Sie den Vorschau-Dienst mit podman-compose down.

Aufbau

Pfad Inhalt
docs/git/ Versionsverwaltung mit Git
docs/markdown/ Markdown-Syntax und Dokumentationsstruktur
docs/container/ Container, Podman und Docker
zensical.toml Website-Konfiguration
compose.yaml Einstellungen für den Zensical-Container

Weitere Themenbereiche liegen ebenfalls unter docs/ und werden automatisch in die Navigation aufgenommen.