Skip to content

开发记录:VitePress知识库首页与导航增强

这篇开发记录用于复盘 M1 的背景、目标、执行过程和最终结果。

为什么在 M1 先补首页与模块导航增强

M0 已经解决了最基础的问题:仓库里的 Markdown 资料可以通过 VitePress 跑起来,并且能通过生成脚本自动镜像到站点源目录中。但如果只停留在这个阶段,站点仍然更像“能打开的资料集合”,而不是“可以稳定进入和阅读的知识站点”。

只要入口表达不清楚,后面即使继续补搜索、发布或 SEO,也会一直面临这些问题:

  • 新用户进入首页时,很难快速理解站点里到底有什么
  • 模块很多,但没有更明显的优先进入路径
  • 内容导航页虽然完整,却仍然偏“纯清单”,缺少推荐入口
  • 后续专题入口不好继续往上叠加

所以 M1 选择先补首页和模块导航增强,是为了先把“站点入口层”打稳。

这轮做了什么

这轮主要完成了这些事情:

  • 新增当前站点重构项目的里程碑规划文档
  • 新增 M1 任务拆解文档
  • 新增 M1 详细设计文档
  • 调整 scripts/generate-vitepress.mjs,增强首页与总览页生成逻辑
  • 给首页补齐重点模块与推荐专题区
  • 给内容导航页补齐优先模块与推荐入口信息
  • 给模块总览页补齐推荐入口区

这轮最重要的决策

决策一:继续坚持“生成优先”

这轮没有改成手工维护首页与目录页,而是继续把首页、总览页和模块页都放回生成脚本里统一产出。

这样做的原因是:

  • 后续新增模块时仍然可以自动接入
  • 不会形成“脚本生成一套、手工改一套”的双轨维护问题
  • 后面做 M2M3 时还能继续在生成逻辑上迭代

决策二:首页优先表达“怎么进入”,而不是“什么都展示”

这轮没有试图在首页塞太多目录,而是重点表达:

  • 站点规模
  • 重点模块
  • 推荐专题
  • 基本定位

这样首页更像入口页,而不是又一个超长总目录。

决策三:模块总览页补推荐入口,而不是只补统计数字

如果只是补文档数,页面价值仍然不够明显。这轮更重要的动作,是让每个模块都给出一小组推荐入口,让总览页具备“先去哪里看”的指导能力。

本轮自测怎么做

这轮主要做了下面这些自测:

  • 执行 npm run docs:sync,确认站点镜像生成通过
  • 执行 npm run build,确认 VitePress 构建通过
  • 执行 vitepress preview,确认预览服务可启动
  • 使用 curl 检查首页访问返回 200
  • 使用 curl 检查 内容导航/ 页面访问返回 200

本轮结果

M1 完成后,当前站点已经不再只是“把 Markdown 搬进 VitePress”这么简单,而是开始形成比较明确的站点入口结构:

  • 首页可以快速解释站点内容和进入路径
  • 总览页可以先给出重点模块,再给出完整模块列表
  • 模块页可以提供推荐入口,而不是单纯列出全部文档
  • 后续继续做专题入口、推荐阅读和搜索优化时会更顺畅

这意味着下一轮如果继续扩展:

  • Vue / 面试 / 工程化专题入口
  • 模块内推荐阅读链路
  • 高价值模块的首页卡片化表达
  • 站点发布与搜索体验增强

都已经有了更稳定的挂载点。

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