跳转到主要内容

这是本节的多页打印视图。 .

返回本页常规视图.

OINK 案例

十五个真实站点展示 OINK 如何覆盖两页小工具、多语言文档群与三本书籍。

十五个站点项目,从两页的小工具到多语言文档体系与三本书。 点击卡片先阅读案例,再访问其中的站点或源码链接。也可以按案例导览 比较与自己目标形态接近的站点。

1 - pgsty.com

PGSTY 是 Pigsty 背后的公司。这个小型双语公司站主要将 OINK 用作数据驱动的落地页系统。

pgsty.com 是 Pigsty 背后的双语公司站,总共只有十来个 页面:首页使用 type: home,由 data/home/{en,zh}.yaml 组装,其余则是 解决方案、公司信息与价格等聚焦单页。

它展示了什么

  • 几乎不建文档树,也能把 OINK 用作落地页主题。
  • 把紧凑的中英文营销页面作为对等内容维护。
  • 从可复用数据分区搭建首页叙事。

如果项目希望沿用 OINK 的品牌、导航、搜索与多语言约定,但主要需要的是小型 公开站而不是手册,可以采用这一模式。

→ 首页与落地页 · 全部 OINK 案例

2 - pigsty.cc

开源 PostgreSQL 发行版 Pigsty 的中文主站。独立部署的单语站让大规模中文语料按自己的节奏持续演进。

pigsty.cc 以简体中文发布 Pigsty。本案例记录的快照有 一千四百九十多个内容文件、三百多篇博客,并拥有独立的数据驱动价格页, 中文也是站点的默认语言。

它展示了什么

  • 把体量很大的双语语料拆成两个独立部署的单语站。
  • 通过替代站点入口与版本菜单连接中英文站。
  • 让每种语言拥有独立的发布节奏与落地页数据。

这一模式牺牲同域语言切换,换来更清晰的维护边界和更小的构建规模。两种语言 都已经是完整产品,而不是零星翻译时,尤其适用。

→ 多语言配置 · pigsty.io 案例

3 - pigsty.io

开源 PostgreSQL 发行版 Pigsty 的英文主站,将大型发行版手册、博客、扩展目录与价格落地页集中在一起。

pigsty.io 是开源 PostgreSQL 发行版 Pigsty 的英文主站。 本案例记录的快照包含一千四百多个 Markdown 文件、两百多篇博客、扩展目录, 以及由数据驱动的价格页面。

它展示了什么

  • 在同一个 Hugo 站点中组织大型文档树与编辑型博客。
  • 把目录内容与结构化数据分开维护。
  • 用 layout: landing 和 data/landing 组装价格页。
  • 用分类法与版本菜单连接同系列站点和历史版本。

当一个英文优先的站点需要同时承载参考手册、动态内容、目录与商业落地页时, 可以采用这一模式。

→ 首页与落地页 · 全部 OINK 案例

4 - silo.pgsty.com

SILO 是社区维护的 MinIO 分支,提供兼容 S3 的对象存储。这个大型双语迁移案例从经过检查的清单生成文档导航。

silo.pgsty.com 是 S3 兼容对象存储 SILO 的文档站。 本案例快照中每种语言各有四百一十一页。覆盖 387 个上游页面的迁移清单生成 data/docs_nav.json,再由它驱动文档侧栏;站点还提供模块分类法与下载页。

它展示了什么

  • 迁移大型上游手册,同时保留原有信息结构。
  • 从受检查的清单生成导航,避免手工维护整棵目录树。
  • 在导入文档外叠加本地双语内容、分类与下载界面。

当上游语料仍是权威来源,而本地站需要自己的导航、语言对等页和产品界面时, 可以采用这一模式。

沿导航数据划分职责

已提交的 data/docs_nav.json 通过 meta.generated_from(migration/reports/navigation.csv)与 meta.manifest(migration/minio-docs-manifest.csv)记录输入来源。迁移流程负责这些输入 和生成导航,OINK 读取结果树。这些路径说明数据来历,不代表 OINK 内置了对应生成器。

这一做法以额外维护一份导航产物为代价,保留导入手册的顺序。小型原创手册先用普通内容树; 只有能够同时维护导航源与重新生成流程时,再采用生成导航。

→ 导航定制 · 全部 OINK 案例

5 - oink.pgsty.com

OINK 是本案例库各站点采用的 Hugo 主题。本站将公开手册、设计参考、组件示例与回归测试集中在同一仓库。

oink.pgsty.com 就是你正在阅读的站点。它既是主题的 公开手册,也是真实的回归消费站:组件页面会渲染可运行示例;同一个仓库还 承载设计契约、Book 夹具、下载数据,以及首页和落地页数据。

它展示了什么

  • 文档示例本身就是可执行回归夹具,而不是截图。
  • 一个站点同时服务用户、内容作者、主题开发者与评审者。
  • 组件、Docs、Blog、Book、Case、下载与落地页等界面协同存在。
  • 针对固定的 Hugo Module 依赖检查双语内容。

可以把这个仓库当作完整参考实现;如果新站只需要一两种 OINK 内容模型, 则从更聚焦的案例开始。

→ 组件画廊 · 设计契约 · 全部案例

6 - caps.vonng.com

Capslock 把 Caps Lock 变成第五个修饰键。这个每种语言仅两页的小站,将项目介绍与数据驱动的交互配置器放在一起。

caps.vonng.com 是 Capslock 键盘增强方案的 小站,每种语言只有两个页面:首页与交互式配置生成器。生成器读取 data/capslock-v3.json,并在常规文档外壳之外使用自定义 customizer 外壳。

它展示了什么

  • OINK 站点的实用规模下限:小项目无需为一个工具和简介搭建前端应用。
  • 为单个专用交互页面扩展外壳注册表。
  • 把生成器数据与界面、双语说明分开维护。

当文档很少,但一个交互工具仍需要与全站共享导航、主题与语言控制时,可以 采用这一模式。

把应用留在站点层

站点的 hugo.yaml 把 customizer 加入 params.ui.shell_types。 content/customizer.md 选择 type: customizer 与 layout: customizer,再调用站点自有的 capslock-configurator 短代码。 配置器、JavaScript 与键盘数据都属于站点代码,OINK 不内置这个应用。

小型自定义工具需要文档外壳时,可以复用这条职责边界。交互代码仍需自己维护; 只有两页内容,并不意味着应用本身没有维护成本。

→ 布局配置 · 全部 OINK 案例

7 - pig.pgsty.com

PIG 是 PostgreSQL 扩展包管理器。这个案例将精简的双语产品手册与数据驱动首页、持续更新的博客配合使用。

pig.pgsty.com 是 PostgreSQL 扩展包管理器 PIG 的 文档站。核心手册刻意保持紧凑——本案例快照中每种语言十八页——同时用五十篇 双语博客承载动态、教程与深入说明,首页则由 data/home 组装。

它展示了什么

  • 为聚焦型命令行产品设计浅层、以单文件为主的文档树。
  • 在不重复设计导航的前提下维护中英文对等页面。
  • 让数据驱动首页与体量更大的博客内容流配合使用。

当参考手册小而稳定,但产品动态、教程与版本背景需要持续增长时,可以采用 这一模式。

复用分工,不复制产品数据

Docs 根页 选择文档类型;独立的 data/home/metrics.yaml 把产品计数从正文中分离。站点维护这些事实与消费数据的模板,OINK 提供阅读外壳。

小型产品可以先用普通 Docs 文件,只有多处复用的事实才放入结构化首页数据。 复用这一组织方式,不要复制 PIG 的软件包数量或产品专属首页实现。

→ 文档仓库结构 · 全部 OINK 案例

8 - sow.pgsty.com

SOW 用于构建与镜像 APT、YUM 软件仓库。双语运维手册与下载页共享结构化发布元数据。

sow.pgsty.com 记录 APT 与 YUM 仓库管理器 SOW。 本案例快照中每种语言各有五十五页,并提供独立下载页;版本、标签与发布产物 都由结构化发布数据生成。

它展示了什么

  • 以中等体量维护双语运维文档。
  • 给下载内容独立类型,而不是把链接散落在正文里。
  • 复用发布数据,让软件包元数据只有一个事实来源。

如果软件面向多个平台分发大量产物,并且安装说明、软件源与下载信息需要同步 演进,可以采用这一模式。

→ 发布与下载页 · 全部 OINK 案例

9 - exp.pgsty.com

PG Exporter 是面向 PostgreSQL 与 PgBouncer 的 Prometheus 指标采集器。这个双语手册结合了生成导航、结构化指标目录与系统字体。

exp.pgsty.com 是 PostgreSQL Prometheus 指标采集器 PG Exporter 的文档站。本案例快照中每种语言各十五页,另有三十七篇双语博客; 生成导航、首页数据与结构化指标目录承担了主要的信息组织工作。

它展示了什么

  • 在规模不大但顺序明确的手册中使用 data/docs_nav.json。
  • 从结构化数据渲染领域目录,避免在正文中反复复制。
  • 需要避免请求品牌字体时,选择 typography: system。

当技术产品的参考数据与叙述型文档同样重要,尤其希望字体栈更轻量时,可以 采用这一模式。

→ 字体与品牌 · 全部 OINK 案例

10 - ddia.vonng.com

《设计数据密集型应用》的多语言书籍站,也是 OINK 图表编号、交叉引用与索引的重要应用案例。

ddia.vonng.com 以多语言书籍形式发布《设计数据密集型 应用》。本案例快照包含简体与繁体中文各二十四章、第二版英文二十三章,以及 第一版的两套二十一章内容。

它展示了什么

  • 带章节级导航的完整 type: book 阅读外壳。
  • 一百三十多处图、表、公式与示例编号目标。
  • 跨多个版本保持稳定的交叉引用和生成式书籍索引。
  • 在同一出版物中承载多种书面语言变体。

如果长篇内容更看重编号、引用与章节间移动,而不是文档式侧栏,可以采用 这一模式。

→ 创作书籍 · 全部 OINK 案例

11 - tpme.vonng.com

《The Product-Minded Engineer》的双语书籍站,以精简的 OINK Book 外壳组织长篇阅读。

tpme.vonng.com 以中英文发布 The Product-Minded Engineer,本案例快照中每种语言各十八章。它把支持的页面外壳收窄为 [book]。

它展示了什么

  • 只有一种内容模型、完全不需要文档外壳的出版物。
  • 共享视觉与导航体系的双语章节对等页。
  • 比多版本 DDIA 站更精简的 Book 实现。

对于单本教程或译著,这是更清晰的起点:先把站点架构保持精简,再按手稿需要 逐步加入编号与索引。

只保留书籍需要的阅读模型

站点的 hugo.yaml 在 params.ui 中设置:

params:
  ui:
    typography: system
    shell_types: [book]
    docs_section: ''

这让共享外壳聚焦于书籍,并采用系统字体;它不会自动把任意页面转换为章节。 手稿、语言配置与 Book front matter 仍由站点维护。从Book 根页模式开始, 只有新增独立文档或其它内容栏目时,再加入对应外壳类型。

→ 创作书籍 · DDIA 案例

12 - pgint.vonng.com

《PG 技术内幕》的中文译本站。它只使用 Book 阅读外壳,没有另建文档树。

pgint.vonng.com 发布《PG 技术内幕》——Hironobu Suzuki《The Internals of PostgreSQL》的 2018 年中文译稿。站点包含两篇序言、 十一个章节、自动生成的目录,以及一页许可与授权说明,全部为简体中文,没有 英文对等版本。

它展示了什么

  • 一个刻意保持单语的 OINK 站点:只有一棵语言树,语言切换器因为无处可切而 自然让位。
  • Book 外壳承载的是已完成的译稿而非持续演进的手册——章节导航、整书打印输出 与落地页共处一站。
  • 落地页同时署名上游作者与译者,并向持续更新的英文原著给出外链。

当文本已经定稿——完成的译稿或已出版的著作——可以采用这一模式:内容不会再 增长,站点要做的是导览、阅读体验与如实署名,而不是变更管理。

→ 编写书籍 · TPME 案例 · DDIA 案例

13 - PostgreSQL 组件文库

PostgreSQL 组件运维文库:让多个上游手册与完成度不一的翻译树共享搜索和视觉体系。

PostgreSQL 组件文库 把 Patroni、HAProxy、etcd、PgBouncer、pgBackRest 与 pgBadger 的运维手册汇总为一套 PostgreSQL 专题文库。本案例快照中有 二百一十七页英文内容与八十页中文内容。

这个案例介绍 Hugo 组件文库项目;PGSQL.CC 中文门户是独立的 Django 应用。

它展示了什么

  • 为多个上游产品建立一致的本地信息架构。
  • 英文先发布、中文覆盖逐步增长。
  • 不强求翻译完全对等,也能让现有译文及时可用。
  • 用子树在汇编站中保留清晰的产品边界。

当技术文库的来源与翻译成熟度各不相同,但读者需要统一搜索与视觉体系时, 可以采用这一模式。

→ 多语言配置 · 全部 OINK 案例

14 - pgsty.pro

PIGSTY PRO 是 Pigsty 的企业版。双语文档与版本档案围绕可复用的结构化发布记录组织。

pgsty.pro 用中英文记录 Pigsty v5。本案例快照中,每种 语言各有三百四十三页文档,另有六十七篇双语博客。它最突出的部分是版本档案: 128 个本地化页面通过可复用的 release-card 组件渲染版本数据。

它展示了什么

  • 无需手工维护每张卡片,也能让长期产品历史清晰可查。
  • 在下载页、版本档案与详情页之间共享结构化发布数据。
  • 让文档与编辑型内容保持中英文对等。

如果产品拥有许多在役或历史版本,并且多个页面都要展示一致的发布元数据, 可以采用这一模式。

→ 发布与下载页 · 全部 OINK 案例

15 - ext.pgsty.com

PostgreSQL 扩展目录。案例快照收录 2,241 个扩展,其中 576 个已打包,可按 16 个 Linux 平台与 5 个 PostgreSQL 大版本查询。

ext.pgsty.com 是 PostgreSQL 扩展目录:可以按扩展、 软件包系列、依赖,以及每个扩展可用的 PostgreSQL 与操作系统组合进行检索。目录收录 2,241 个扩展,其中 576 个已打包,覆盖 16 个 Linux 平台与 5 个 PG 大版本。

它展示了什么

  • 以可检索的数据集为站点主体,并隐藏不必要的阅读导航。
  • 目录与正文共处一个 OINK 站点,这与 PG Exporter 和 pigsty.io 安放结构化数据的方式一致。

→ PG Exporter 案例 · pigsty.io 案例 · 全部 OINK 案例