Guidedog / 文档 0.2.0

Guidedog 手册

写一份源码，讲清楚道理，同时发布到网页与纸上。

Guidedog 将 reStructuredText 和 Markdown 源文件构建为 HTML 网站和 PDF 图书。它无需 Python 环境或外部 LaTeX 安装。转换引擎名为 Guidedoc，PDF 由 Typst 排版，网站由 Guidedog 直接生成。

小型项目只需三样东西：源文档、目录和 conf.toml。从 第一个项目 开始。具体任务查阅 实用任务，准确约定查阅 参考。

图 1 一套源文件，两种出版形式。

学习

• 教程

  • 第一个项目

  • 制作一本小书

• 专题指南

  • 编写文档

  • 域

  • 项目如何工作

  • 数学与证明

  • 用图表解释概念

  • 适合阅读的排版

  • 模板

  • 图片、视频、音频与下载

  • 国际化

  • 链接到其他项目

  • 声明对象类型

  • 用 autodoc 编写 Python 文档

  • 为 Odin 生成文档

实践

• 实用任务

  • 构建并安装 Guidedog

  • 构建并发布文档

  • 迁移 Sphinx 项目

  • 为代码库生成文档

  • 维护本项目的文档

• 参考

  • 命令行参考

  • 配置参考

  • 读取器、渲染器与构建器

  • 错误信息

  • 与 Sphinx 的兼容性

理解

• 内部机制

  • Guidedoc 引擎

  • 先有不变式，再谈算法

  • 发布完整的一代输出

  • 内存与所有权

• 关于本手册

  • 构建验证记录

• Guidedog

  • 创建项目

  • 安装

  • 从源码构建

  • 用 Guidedog 翻译

  • 阅读与嵌入

  • 致谢与许可

API 参考

• API Reference