元数据

docdoc 用三份 JSON 元数据文件描述站点与文档的结构,各自管一层。它们都随源目录进 git,作者直接编辑,没有命令去生成。

文件 位置 管什么
docdoc.json 源目录根 站点:标题、语言、子文档、版权、图标
doc.docdoc.json 子文档目录根 子文档:Tab 标题、语言支持、缺省侧栏渲染器
metadata.docdoc.json 任意目录内 该目录:侧栏顺序、目录标题、子树渲染器
  • 三份文件都是 i18n 友好的:标题类字段形如 {语言码: 文本},按页面语言解析
  • 站点清单可以整个缺省:无清单模式直出单文档站点(站内搜索 ?docdoc.json)

与配置的边界

元数据描述文档源的结构,随源目录走;配置描述服务器进程的行为,只存在于每台服务器(config.yaml,站内搜索 ?config.yaml)。两者不混用:不会在 docdoc.json 里写端口,也不会在 config.yaml 里写章节顺序。

各文件字段说明: