Erste Schritte¶
Neue Seite anlegen¶
- Neue Markdown-Datei unter
docker/mkdocs/docs/anlegen, z. B.runbooks/backup-restore.md. - Seite in der Navigation eintragen:
docker/mkdocs/mkdocs.yml→ Abschnittnav:. - Bei laufendem Container wird die Seite automatisch neu geladen
(Live-Reload von
mkdocs serve) — kein Neustart nötig.
Mermaid-Diagramme einbinden¶
Mermaid ist direkt über die Material-Theme-Integration aktiviert (siehe
pymdownx.superfences unter markdown_extensions in mkdocs.yml) — es
braucht kein zusätzliches Plugin oder Image. Ein Codeblock mit der Sprache
mermaid reicht:
```mermaid
graph TD
A[Start] --> B[Ende]
```
Unterstützte Diagrammtypen u. a.: graph/flowchart, sequenceDiagram,
classDiagram, stateDiagram-v2, erDiagram, gantt. Beispiele siehe
Architektur.
Produktiv-Hinweis¶
Der Container läuft standardmäßig im mkdocs serve-Dev-Modus (Live-Reload,
kein statischer Build) — passend für ein internes Setup mit wenigen Lesern.
Details zu einem produktiveren Rollout stehen in
docker/mkdocs/README.md.