Skip to content
Handbook 写作与扩展规范

写作与扩展规范

这套网站应该像研究系统一样被维护:结构稳定、内容可查、每次更新都有清晰目的。

页面结构

每个页面建议包含:

  1. 一个明确标题。
  2. 一段说明本页解决什么问题。
  3. 若干二级标题,对应可独立查阅的知识块。
  4. 必要时加入表格、清单和下一步链接。

写作原则

  • 用中文直接表达,不堆术语。
  • 每一节都尽量回答“学生看完后能做什么”。
  • 避免只列工具名,要解释工具在工作流中的位置。
  • 对经验性判断,写清楚适用场景和限制。

扩展新章节

  1. 在对应目录中新建 Markdown 文件。
  2. .vitepress/config.tssidebar 中加入链接。
  3. 使用 npm run dev 本地预览。
  4. 使用 npm run build 确认静态构建正常。

复用到医疗 AI 站点

未来的 dive-into-ai-for-healthcare 可以复用同一技术栈:

  • 复制 .vitepress/theme 作为共享主题起点。
  • 替换 .vitepress/config.ts 中的站点标题、导航和侧栏。
  • 保持 Markdown 页面结构一致,降低维护成本。