Appearance
本项目工作流查看幻灯片:本项目工作流
这个仓库把一篇技术分享拆成几个固定环节:Trellis 记录任务,archive.md 保存主稿,docs.md 面向网页阅读,slides.md 面向现场演示,最后通过 pnpm run sync 和 pnpm run build 验证发布产物。
为什么要这样做
同一份分享通常会被多次改写。网页需要完整解释,演示需要节奏,主稿需要留档。如果没有一个明确的源头,几次修改之后就很容易出现标题、摘要、文档和幻灯片互相对不上。
所以本项目约定:archive.md 是主稿。只要主稿变化,就同步检查 docs.md、slides.md 和 meta.yaml。
目录分工
每篇分享都放在 content/shares/<slug>/:
| 文件 | 作用 |
|---|---|
meta.yaml | 标题、slug、日期、摘要、标签和发布状态 |
archive.md | 最完整的主稿,用于留档和后续改写 |
docs.md | VitePress 阅读版,发布到 /docs/<slug>/ |
slides.md | Slidev 演示版,入口是 /sli/<slug> |
assets/ | 可发布的图片、截图和图表 |
_drafts/ | 临时笔记,不进入发布内容 |
执行顺序
- 先确认分享目标、受众和范围。
- 需要任务化时,用 Trellis 创建任务,并把要求写进
prd.md。 - 修改
archive.md,让主稿完整。 - 根据主稿同步改
docs.md和slides.md。 - 检查
meta.yaml是否还匹配当前主题。 - 运行
pnpm run sync,生成 VitePress 页面。 - 运行
pnpm run build,确认/docs/和/sli/<slug>对应页面都能构建。
完成标准
内容写完之后,还要满足这些条件:
- 三份内容表达同一个主题,没有旧标题或旧摘要残留。
- 生成目录只由脚本生成,不手动改
docs/<slug>/index.md。 - Slidev 演示稿复用共享样式和组件。
- 图片等发布资产都放在
content/shares/<slug>/assets/。 - 构建通过后,才可以认为这篇分享处于可发布状态。