专题与资料书
用稳定链接、专题顺序和资料书目录组织同一批文章。
本篇以 first-note 为例,请先按新建、预览与发布文章创建它。接下来将它加入一个专题和一本资料书。
文章 ID
id 在整个内容根中唯一。参考资料、随记和项目也有自己的 ID,即使分别放在不同目录,也不能重复。标题可以改善,文件夹可以整理,但已经发布的 ID 应继续保留。
文章和参考条目都放在 knowledge/articles,通过 type: article 或 type: reference 区分。参考条目适合记录来源、收藏理由、适用场景和自己的解释,不必复制一篇外部文章。
正文链接与附件
链接到其他条目时使用稳定 ID,例如 [阅读第一篇记录](content:first-note)。目标须先存在。构建时会自动加上部署的 base,并按目标类型生成文章、随记或项目的地址。
相对源链接适合在编辑器里跟读,例如 [另一份源文件](../other-note/index.md)。图片和下载附件也使用相对路径,例如 。移动源文件时保留 ID,同时检查移出和指向该文件的相对链接。只发布正文实际引用的附件。
专题顺序
创建 knowledge/topics/first-steps.yaml:
id: first-stepstitle: 入门笔记intro: 按顺序阅读入门笔记。entries: [first-note]entries 的排列就是建议阅读顺序,与文章发布日期分开。加入第二篇时,先创建其正文,再将真实 ID 加进数组。不存在的引用会阻断构建,避免发布空入口。
同一篇可以属于多个专题。例如 Markdown 排版教程同时收录在「澄屿入门」和「排版与技术写作」中。从各自的专题进入时,篇次和前后篇按该专题的顺序显示。
资料书目录
创建一本自己的书。若你在演示副本中练习,请用新的书籍 ID,保留演示的 handbook。
id: my-handbooktitle: 我的手边书subtitle: 遇到问题时回来查intro: 保存记录、来源和可再次使用的说明。order: 10theme: indexchapters: - title: 开始记录 children: - title: 第一个问题 children: - id: first-note分支使用 title 和 children,叶项使用 id。目录可以继续嵌套,不把文章正文写进 YAML。运行检查与构建后,资料架出现新书,叶项打开同一篇 first-note。
演示站的使用手册收录六篇教程,网站开发参考收录两份资料,「阅读与笔记」展示空书状态。
选择合适的内容类型
| 类型 | 建议保存什么 | 新建命令示例 |
|---|---|---|
| article | 一个展开的问题与过程 | pnpm new article first-note |
| reference | 来源、用途和解释 | pnpm new reference reading-reference |
| jotting | 短观察、片段和提问 | pnpm new jotting first-jot |
| project | 成品的用途、功能和使用入口 | pnpm new project first-project |
表中命令分别创建不同内容,不要对已有 ID 重复执行。它们都从私人草稿开始。随记可以设置 time,同日记录按时间倒序;项目的真实地址留空时不出现按钮,示意图预设不等于项目截图。
引用校验
删除正文前,搜索它的 ID,检查专题、书籍、正文链接、关联阅读和首页配置。移动源文件后再跑一次检查,因为相对链接和附件仍跟随文件位置。
构建先过滤目标内容,再计算目录、计数和索引。因权限过滤而没有可见条目的书籍不会输出;主动设置 chapters: [] 的空书会保留。列表页数根据当前可见内容生成。
整理完成后运行 pnpm check 和 pnpm build,再检查原有正文地址和集合入口。
按专题顺序继续阅读
按专题顺序继续阅读