Guidedog / Dokumentation 0.2.0

Reader, Renderer und Builder¶

Ein Reader versteht eine Quellsprache, ein Renderer schreibt einen Dokumentbaum, ein Builder koordiniert das Projekt und veröffentlicht die Ausgabe. Das sind verschiedene Aufgaben.

Tabelle 18 Verarbeitungswege¶
Eingabe	Reader	Weg
RST im Projekt	RST mit eingebauter Sphinx-Schicht	Vom Projektgraphen zu HTML, Typst/PDF, Text oder Katalogen.
Markdown im Projekt	MyST-kompatible Markdown-Schicht	Derselbe Projektgraph und dieselben Builder.
`convert file.md`	CommonMark als Vorgabe	Ein Dokument nach HTML oder Typst/PDF.
`convert file.typ`	Nativer Typst-Adapter	Typst-Kompilierung außerhalb des semantischen Baums von Guidedoc.

Builder¶

html: Eine HTML-Datei je Dokument, mit Indizes, Suche und Inventar.
dirhtml: Dokument-URLs im Verzeichnisstil.
singlehtml: Eine HTML-Hauptseite mit Dokumentabschnitten und lokalen Verweisen.
pdf: Vom Projekt definierte Typst-Bücher. LaTeX-Builder-Aliase wählen diesen Weg.
text: Textdateien für die Dokumente.
gettext: Nachrichtenvorlagen für Übersetzungen.
dummy: Liest und löst das Projekt auf, ohne ein Artefakt zu veröffentlichen.

Abdeckung ist ein Nachweis¶

guidedog formats zeigt die tatsächlich vorhandenen Adapter. Die Kompatibilitätsseite dokumentiert feste Testsuiten und reale Projekte. CommonMark-Erfolg beweist keine vollständige MyST-Abdeckung; RST-Lesen nicht das Verhalten aller Python-Erweiterungen. Siehe Kompatibilität mit Sphinx.