Skip to content

开发记录:VitePress 内容质量治理与校验链路增强

背景

前四轮改造已经把这个仓库从分散 Markdown 资料逐步推进成了可构建、可浏览、可导览、可发布的知识站。

但站点进入长期维护阶段后,会出现另一个问题:

  • 内容能展示,不代表内容质量可见
  • 构建能通过,不代表历史脏数据被持续发现

所以 M5 的重点,不再是继续增加入口,而是补齐治理和校验链路。

本轮改动

1. 增加原始 Markdown 质量巡检

这一轮在生成流程中直接扫描原始 Markdown 资料,收集:

  • 文档总量
  • 占位页 / 空文件数量
  • 缺少一级标题的文档
  • 本地资源缺失链接
  • 重复标题
  • 文件名尾部空格

2. 新增站点治理总览页

这轮新增了 站点治理/ 页面,把原本只存在于脚本侧的问题统计搬到了站内页面里,方便持续治理。

3. 增加 docs:check

本地现在可以直接运行 npm run docs:check,完成:

  • 构建
  • 关键页面存在性验证
  • 治理报告存在性验证
  • 巡检摘要输出

4. 新增 CI 校验工作流

新增 docs-check.yml 后,dev-vitepressmaster 分支的推送、以及到 master 的 PR,都可以自动执行知识站构建与治理检查。

关键实现点

治理问题必须从原始文件层发现

如果只检查生成后的 docs-site,很多历史问题已经被兜底逻辑掩盖了。

所以 M5 继续坚持在原始 Markdown 层做扫描,再把结果投射成站内页面和构建摘要。

治理页不是给读者看的,而是给维护者看的

这页的作用不是提升阅读体验,而是提升维护效率。所以它更像一个“知识库维护面板”。

构建通过不等于没有问题

docs:check 的价值就在于把“构建成功”和“质量状态可见”拆开。即使当前历史问题仍然存在,维护者也能稳定看到问题规模和优先级。

共 20 个模块,1301 篇 Markdown 文档。