OINK 文档
OINK 是一款只需 Hugo Extended 的技术文档主题：组件写在 Markdown 里，资源随主题分发，双语开箱可用，一份内容产出四种输出。
OINK 是一款技术文档 Hugo 主题。组件是 Markdown 语法的一部分，不是另一套模板语言；浏览器需要的字体、图标、搜索与图表运行时随主题分发；构建依赖只有一个 Hugo Extended 二进制，不需要 Node.js，不请求 CDN。当前发布版本 v0.6.0。
五条入口
- 十分钟上手 — 安装 Hugo、克隆本站、替换站点信息、部署。
- 组件总览 — 每个组件一页，先给源码再给渲染效果。
- 使用 OINK 创作优美的内容 — 从第一次预览到持续维护发布物的实战教程。
- 案例 — 把生产站点拆解成可复用的设计与迁移模式。
- 设计与开发 — 面向 OINK 维护者的契约、已接受决策、研究证据与候选提案。
按任务导航
| 你要做的事 | 去哪 |
|---|---|
| 判断是否适用 | OINK 是什么 |
| 安装并预览 | 十分钟上手 |
| 写一页文档 | 编写页面 |
| 把目录树变成侧栏 | 组织内容 |
| 查组件写法 | 组件总览 |
| 改站名、Logo、配色与字体 | 品牌外观 |
| 查某个配置键的默认值 | 配置总览 |
| 做双语或多语言站 | 多语言 |
| 从头到尾掌握 OINK | 使用 OINK 创作优美的内容 |
| 研究生产环境实现 | 案例 |
| 部署到线上 | 发布上线 |
| 升级版本或从 Docsy 迁移 | 版本升级 |
| 维护主题、审查契约或编写 PRD | 设计与开发 |
Docs 的七个栏目按阅读顺序排列：了解、上手、写内容、查组件、改站点、管发布，最后理解并维护其背后的契约与设计记录。
一款只需 Hugo Extended 的技术文档主题，从 Docsy 演化而来，组件写在 Markdown 里，资源随主题分发，十四个生产站点在用。
克隆 OINK 文档站，本地预览，替换站点信息，部署到 GitHub Pages。
写文档页、博客、书籍、发布页与 API 文档：一页文档长什么样，内容怎么组织。
写文档时可用的全部组件，一个组件一页，例子由浅入深，参数表在页尾。
站点级配置：品牌、导航、布局、搜索、多语言、多版本、打印与 Agent 输出。
站点从本机到线上的运维事项：本地预览、发布上线、评论、分析与 SEO、版本升级与排错。
在唯一的双语专栏中管理 OINK 维护者契约、已接受决策、定期研究与候选提案。