# 使用 Oink 创作优美的内容

> 一本实战教程：用 OINK 创作清晰、优美且易于维护的技术内容。

---

LLMS 索引： [llms.txt](/zh/llms.txt)

---

《使用 Oink 创作优美的内容》是 OINK 参考文档的教程伴侣。参考文档解释每个参数和组件的作用；
本书正在沿着一个 Starter 站点，逐步编写从本地预览到评审与发布的练习。

前三章已放入可直接操作的内容。后续章节在完整演练写作期间，会刻意展示 Book 的草稿状态。

## 阅读方式 {#reading-path}

从[第 1 章：跑起第一个站点](/zh/book/01-start/)开始。第 1–3 章沿用同一个 Starter，
依次完成预览、新建双语页面和完善正文。第 4–6 章与附录仍为提纲草稿；需要现在完成
定制与部署时，请继续[Starter 教程](/zh/docs/start/starter/)，再按[发布上线](/zh/docs/admin/deploy/)操作。
下方对象索引同时演示 Book 的出版能力，可在需要查图表和示例时使用。

## 目录 {#contents}

- [1 跑起第一个站点](/zh/book/01-start/)
  - [明确结果](/zh/book/01-start/#outcome)
  - [安装前置工具](/zh/book/01-start/#prerequisite)
  - [启动本地预览](/zh/book/01-start/#preview)
  - [记录基线](/zh/book/01-start/#baseline)
- [2 组织内容](/zh/book/02-structure/)
  - [从读者的问题出发](/zh/book/02-structure/#reader-questions)
  - [搭建内容树](/zh/book/02-structure/#content-tree)
  - [明确写出顺序](/zh/book/02-structure/#ordering)
  - [建立稳定地址](/zh/book/02-structure/#stable-addresses)
- [3 组合页面](/zh/book/03-compose/)
  - [让每个内容块只做一件事](/zh/book/03-compose/#one-job)
  - [从一份小型页面契约开始](/zh/book/03-compose/#page-contract)
  - [不用装饰数量衡量质量](/zh/book/03-compose/#quality)
  - [连接证据](/zh/book/03-compose/#connect-evidence)
- [4 塑造体验](/zh/book/04-design/)
  - [建立视觉层级](/zh/book/04-design/#hierarchy)
  - [编排首页](/zh/book/04-design/#home)
  - [保持导航可预期](/zh/book/04-design/#navigation)
  - [同时设计两种语言](/zh/book/04-design/#languages)
- [5 选择内容类型](/zh/book/05-publishing/)
  - [让内容类型匹配读者](/zh/book/05-publishing/#surfaces)
  - [配置 Blog 家族](/zh/book/05-publishing/#blog-family)
  - [把样例变成 Case 案例](/zh/book/05-publishing/#case-studies)
  - [让 Book 与 Docs 相互补充](/zh/book/05-publishing/#book-and-docs)
- [6 校验与交付](/zh/book/06-ship/)
  - [为每种交付状态命名](/zh/book/06-ship/#delivery-states)
  - [验证最小且有效的范围](/zh/book/06-ship/#validate)
  - [审阅真正渲染出的结果](/zh/book/06-ship/#visual-review)
  - [交接事实，而不是暗示](/zh/book/06-ship/#handoff)
- [A 附录：模式](/zh/book/appendix-patterns/)
  - [Book 栏目根页](/zh/book/appendix-patterns/#section-root)
  - [Book 章节](/zh/book/appendix-patterns/#chapter-pattern)
  - [沉浸式 Blog 文章](/zh/book/appendix-patterns/#article-pattern)
  - [生成输出矩阵](/zh/book/appendix-patterns/#output-matrix)

## 图目录 {#figures}

- [图 1-1](/zh/book/01-start/#fig-first-preview) — 文档站效果示意。你的 Starter 预览使用中性示例内容；第一个里程碑是能打开并修改的站点。

## 表目录 {#tables}

- [表 2-1](/zh/book/02-structure/#tbl-reading-order) — 同一个显式顺序被导航、翻页与生成目录共同使用。
- [表 6-1](/zh/book/06-ship/#tbl-delivery-states) — 每种交付状态都有自己的证据与交接要求。
- [表 A-1](/zh/book/appendix-patterns/#tbl-output-matrix) — 同一棵内容树可以生成多种面向不同用途的 Book 输出。

## 公式目录 {#equations}

- [公式 3.1](/zh/book/03-compose/#eq-page-quality) — 清晰度、准确性或一致性中任何一项降为零，整个页面就会失败。

## 示例目录 {#examples}

- [示例 3-1](/zh/book/03-compose/#eg-page-contract) — 同一页面现在明确了前置条件、命令与可见结果。

---

本节页面：

- [从一个能运行的站点开始](/zh/book/01-start/): 安装前置工具，启动本地预览，在调整设计前先建立可见的基线。
- [为内容建立结构](/zh/book/02-structure/): 让目录、分区索引、页面包与权重共同构成可预期的阅读与导航顺序。
- [组合出值得阅读的页面](/zh/book/03-compose/): 把正文、提示块、代码、媒体、表格与数学公式组合在一起，而不把页面变成组件目录。
- [塑造阅读体验](/zh/book/04-design/): 把稳固的内容结构变成一份可辨识、响应式且双语对齐的出版物。
- [发布不止于参考页面的内容](/zh/book/05-publishing/): 用 Docs、Blog、Case、Book 与发布页面分别回答读者的不同需求。
- [有把握地交付](/zh/book/06-ship/): 区分本地预览、仓库集成、主题发布与站点部署，并用对应证据验证每一种状态。
- [Front Matter 模式](/zh/book/appendix-patterns/): 可复制调整的 Book 根页、章节、沉浸式 Blog 文章与整书输出契约。

---

反链：

- [文档](/zh/docs/)
- [书籍出版](/zh/docs/write/book/)