frontmatter 参考
没有配置文件。 全部配置都写在源文档开头的 frontmatter 里 —— 那两行 --- 中间的部分。
这么定的理由是:一份源文档 = 一个产物,配置跟着文档走,拷贝文档就等于拷贝配置。多一个配置文件就多一处「文档在这、设置在那」的脱节。
认识的字段
只有六个。写别的会报 DOC-102 警告并列出这份清单 —— 不静默忽略,因为静默忽略会让你以为配置生效了。
spec
作用是单一的:标记「这是一本 pamphlet 的源文档」。当前编译器支持的版本是 1。
写得比编译器支持的高会报 DOC-101,提示升级。不是整数报 DOC-103。
它不再触发多套解析器行为 —— 只维护一套解析器。见安装页的兼容性承诺。
title
不填时按这个顺序找:文档里第一个 # 一级标题 → 都没有就用字面量 pamphlet。
theme
内置主题按文档类型分,每套长什么样见内置主题。
命令行的 --theme 压过这个字段 —— 一次性的意图应该能盖过文档的长期设定。
名字不认识报 DOC-106,退回 default 继续编译:主题错了只影响长相,内容是对的。
lang
写进产物的 <html lang="…">。缺省 zh-CN。
它影响屏幕阅读器怎么念、浏览器怎么断行和拼写检查,不影响编译器的任何行为。
toc
最简写法:
完整写法:
目录是纯静态的:一段嵌套列表加锚点链接,零 JavaScript。
一级标题(#)不进目录 —— 它是文档标题本身。deep 超出 1–6 报 DOC-103。
skipTabs 为什么缺省是 true
Tab 面板在语义上是同一话题的几种视角,出现在目录里会让读者以为它们是不同章节。
但 Tab 标题为了无障碍和深链被做成了真标题,注定会进文档大纲 —— 所以目录这一侧必须有这个开关。
position 放哪一侧
缺省是 side:一个常驻的侧边菜单,纯 CSS sticky,零 JavaScript。窄屏(< 60rem)自动退回文档顶部。
想让目录收在正文开头、跟着页面一起往下滚:
这两个值之外的写法报 DOC-103 错误 —— 不静默退回缺省,否则你会以为写的那个值生效了。
engines
command 这条路可以用了;http(远程渲染服务)还没写,写了会得到一条 DOC-104 说明。
将来的形态见接一个自定义图表引擎。
诊断定位到具体字段
frontmatter 的诊断指向出问题那个字段所在的行,不是笼统地指向 ---: