Guidedog / 文档
0.2.0
读取器、渲染器与构建器¶
读取器理解源语言；渲染器输出一棵文档树；构建器协调项目并发布输出。这是不同职责。
| 输入 | 读取器 | 路线 |
|---|---|---|
| 项目中的 RST | RST 与内置的 Sphinx 层 | 将项目图生成 HTML、Typst/PDF、文本或翻译清单。 |
| 项目中的 Markdown | 兼容 MyST 的 Markdown 层 | 使用同一项目图和构建器。 |
convert file.md |
默认使用 CommonMark | 将一份文档生成 HTML 或 Typst/PDF。 |
convert file.typ |
原生 Typst 适配器 | 在 Guidedoc 语义树之外编译 Typst。 |
构建器¶
html-
每份文档一个 HTML 文件，附带索引、搜索和清单。
dirhtml-
目录式文档 URL。
singlehtml-
一个主 HTML 页面，包含各文档章节和本地引用。
pdf-
构建项目定义的 Typst 图书；LaTeX 构建器别名也选择这条路线。
text-
每份文档一个纯文本文件。
gettext-
用于翻译的消息模板。
dummy-
读取并解析项目，不发布输出文件。
覆盖率是一种证据¶
guidedog formats 列出可执行文件实际包含的适配器。兼容性页面记录固定测试集和真实项目检查。通过 CommonMark 测试不代表完整支持 MyST；能读取 RST 也不代表复现所有 Python 扩展。见 与 Sphinx 的兼容性。