跳转到主要内容

使用 Oink 创作优美的内容

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

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

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

阅读方式

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

目录

图目录

  1. 图 1-1 — 文档站效果示意。你的 Starter 预览使用中性示例内容;第一个里程碑是能打开并修改的站点。

表目录

  1. 表 2-1 — 同一个显式顺序被导航、翻页与生成目录共同使用。
  2. 表 6-1 — 每种交付状态都有自己的证据与交接要求。
  3. 表 A-1 — 同一棵内容树可以生成多种面向不同用途的 Book 输出。

公式目录

  1. 公式 3.1 — 清晰度、准确性或一致性中任何一项降为零,整个页面就会失败。

示例目录

  1. 示例 3-1 — 同一页面现在明确了前置条件、命令与可见结果。

安装前置工具,启动本地预览,在调整设计前先建立可见的基线。

让目录、分区索引、页面包与权重共同构成可预期的阅读与导航顺序。

把正文、提示块、代码、媒体、表格与数学公式组合在一起,而不把页面变成组件目录。

把稳固的内容结构变成一份可辨识、响应式且双语对齐的出版物。

用 Docs、Blog、Case、Book 与发布页面分别回答读者的不同需求。

区分本地预览、仓库集成、主题发布与站点部署,并用对应证据验证每一种状态。

可复制调整的 Book 根页、章节、沉浸式 Blog 文章与整书输出契约。