文档站选型记录
结论
选择 VitePress 1.x 作为最小可用文档站。
对比
| 方案 | 优点 | 代价 | 判断 |
|---|---|---|---|
| VitePress | Markdown 原生、中文搜索与多语言配置简单、默认主题可访问性好、GitHub Pages 流程短 | 需要 Node.js,深度内容建模能力有限 | 最适合当前以 Markdown 为核心的小型知识系统 |
| MkDocs Material | 搜索和文档功能成熟,Python 生态稳定 | 双语与主题自定义需要更多配置,现有仓库没有 Python 工具链 | 可行,但维护栈更重 |
| Docusaurus | 多语言、版本化和插件生态完整 | React 构建与目录约束更重,对当前规模过度 | 暂不采用 |
维护策略
文档站直接读取仓库现有 Markdown,不复制一套内容。站内使用本地搜索,GitHub Pages 工作流只在 main 更新或手动触发时部署。依赖锁定并通过 npm ci 安装。