ADR-005:沿用已批准的 MkDocs 文档构建基线¶
- Date:2026-10-29
- Status:Accepted(沿用正式 git-repository-maintenance-proposal-001 §6,实施边界依据用户本轮明确选择本地站点与发布包;没有另称新增独立评审)
- Context:基础平台本地验收完成,路线图仍缺文档阅读入口。docs 只放文档;构建工具及配置位于 infra。
- Decision:使用 MkDocs 1.6.1、其内置主题及搜索,不引入额外主题/插件。MkDocs 负责 Markdown 渲染、导航、搜索与静态输出;薄适配只按清单准备发布源、标注未发布引用、校验产物和归档。保留原文档,不维护第二套规范。Docker 提供独立本地预览和可重用构建阶段;发布配置作为待接入模板交付。
- Consequences:本地无须业务数据库;第三方参考文章、草稿、证据与 secret 不进入静态站点。远端仓库、Runner、Pages 服务与访问控制需后续接入验证,本轮不发布远端。完整标题检索沿用内置能力,不承诺额外中文分词服务。
- Reverts:撤销此基线须新增 ADR,不回改已批准的 Git 维护方案。
依据:MkDocs 配置、GitLab Pages 官方指南。其他方案与排除理由见 docs-site-001/research.md。
[SPEC-KIT APPENDED 2026-10-29] 内置检索兼容验证¶
浏览器实测发现内置 zh 分词依赖未提供的 Node jieba,不能在纯静态站中工作。采用同一内置 search 插件附带的 ja/CJK 分词器,保留中文页面语言;不增加依赖或自研搜索。以中文完整标题实际返回结果作为验收,不声称提供中文语义检索。
检索仅索引页面和章节标题,最少两个字符;验收标题为“权限”,复合短语可分词输入,不承诺任意中文整句匹配。原生 toc 的 slugify 仅增加 section- 前缀,修复主题 CSS 选择器对数字章节 ID 的错误;不改正文、不自研渲染器。关闭内置高亮的外部 CDN 资源以支持纯本地阅读。
2026-10-30 修订¶
构建工具归属已由 ADR-006 替代;主题按用户要求采用 MkDocs Terminal。其余发布边界与严格校验继续适用。