Guidedog / Documentation 0.2.0

Readers, renderers, and builders¶

A reader understands a source language. A renderer writes one document tree. A builder coordinates a project and publishes its output. These are different responsibilities.

Table 18 Source routes¶
Input	Reader	Route
RST in a project	RST plus the built-in Sphinx layer	Project graph to HTML, Typst/PDF, text, or catalogs.
Markdown in a project	MyST-compatible Markdown layer	The same project graph and builders.
`convert file.md`	CommonMark by default	One document to HTML or Typst/PDF.
`convert file.typ`	Native Typst adapter	Typst compilation outside Guidedoc’s semantic tree.

Builders¶

html: One HTML file for each document, with indexes, search, and an inventory.
dirhtml: Directory-style document URLs.
singlehtml: One main HTML page with document sections and local references.
pdf: Typst books defined by the project. LaTeX builder aliases select this route.
text: Plain text files for documents.
gettext: Message templates for translation.
dummy: Reads and resolves the project without publishing an artifact.

Coverage is evidence¶

guidedog formats reports the executable’s actual adapters. The compatibility page records pinned suites and real-project checks. Passing a CommonMark suite does not establish complete MyST coverage. Reading RST does not establish every Python extension’s behavior. See Compatibility with Sphinx.