发布不止于参考页面的内容
用 Docs、Blog、Case、Book 与发布页面分别回答读者的不同需求。
5 发布不止于参考页面的内容
用 Docs、Blog、Case、Book 与发布页面分别回答读者的不同需求。
同一个站点可以发布多种知识,而不必把它们强行塞进同一种布局。内容类型选择页面外壳, front matter 变体则在同一外壳内调整呈现。
让内容类型匹配读者
- Docs 回答任务或参考问题,并显示它在内容树中的位置。
- Blog 是带日期、作者、分类法、订阅源与分享能力的文章。
- Case 说明真实站点如何应用主题。
- Book 章节组成有意设计的阅读顺序,并提供稳定交叉引用。
- 发布注记把版本、迁移方法与验证证据连接起来。
配置 Blog 家族
普通 Blog 分区可以选择水平条目(list)、规则卡片(cards)、紧凑表格(table)
或封面画廊(gallery)。OINK 1.4.0 已支持这四种布局。博客布局指南
介绍了配置方法、读者切换与画廊的三种内部排布。
需要沉浸式开场的分区仍然保留同一类型,只改变四个相互独立的呈现键:
这与沉浸式阅读使用的是同一套配置,共享标准的 blog
模板、订阅源与分类页面。
把样例变成 Case 案例
Case 索引采用 Blog 卡片布局;每篇案例页先介绍站点定位、源码仓库、多语言结构、内容规模与所用到的 OINK 特性,再附上线上链接,方便读者在访问外部站点前先了解其实现方式。
让 Book 与 Docs 相互补充
参考页面保持完备,并能独立搜索。教程则从参考中选出一条路径,每次只引入一项决策, 在读者需要完整参数表时再链接回参考文档。
为了体会版本发布公告与常青文档树如何分工协作,可以在 Starter 仓库中新建 content/blog/release/0.2.0.zh.md(及对应的英文 0.2.0.md),并直接链接到第 3 章编写的操作指南:
content/blog/release/0.2.0.zh.md
打开 http://localhost:1313/zh/blog/release/0.2.0/:发布公告负责交代变更在 何时、为何 上线,而 /zh/docs/preview-check/ 则始终作为读者随时查阅的 操作手册。