Skip to content

写作与发布

适用场景

新增或修改知识库内容,需要保证入口清楚、页面能访问、构建能通过。

前置条件

  • 已安装依赖
  • 知道内容属于哪个栏目
  • 已准备好页面标题和要点

标准步骤

  1. 在对应目录创建或更新 Markdown 页面。
  2. 如果是新页面,补到对应栏目的侧边栏。
  3. 在栏目首页增加入口,避免新内容藏得太深。
  4. 跑一次构建,确认没有坏链接和明显错误。

发布前检查

检查项通过标准
标题清楚一眼看懂页面要解决什么问题
位置正确页面放在合适栏目,没有跑偏
入口可达首页、栏目页或侧边栏能进入
内容完整至少写清背景、结论或步骤
构建正常npm run docs:build 可通过

不建议这样写

  • 把很多主题塞进一页
  • 只写结论,不写场景
  • 新增页面但不给入口
  • 还没整理好的草稿直接放进主栏目

推荐做法

能沉淀成模板的内容,优先补到 demo;真实规则和真实流程,再写进 notesplaybooks

基于 VitePress 的个人知识库骨架