快速上手

使用 Hugo Extended 构建双语 Oink 文档站。

Oink 是一款将完整浏览器运行时随主题提供的 Hugo 主题。消费站点只需 Hugo Extended 即可构建;默认流程不安装 Node.js 软件包、不运行 PostCSS、不依赖 CDN,也不会在构建期间远程下载主题资源。

选择起点

  • Hugo Module(推荐):在已有或新建 Hugo 站点中导入 github.com/pgsty/oink。参阅 Oink 快速开始
  • 项目站点:把独立的 pgsty/oink.pgsty.com 仓库作为完整双语配置与回归参考。
  • 现有 Docsy 站点:按照迁移指南删除公共覆盖和消费端 npm 资源管线,无需重写正文。

安装前提条件

安装 Git、Go 与 Hugo Extended 0.160.1 或更高版本。平台说明和验证命令请参阅开始之前

添加 Oink

在站点根目录运行:

hugo mod init github.com/example/product-docs
hugo mod get github.com/pgsty/oink@THEME_REF

然后在 hugo.yaml 中导入主题:

module:
  imports:
    - path: github.com/pgsty/oink

THEME_REF 固定为发布标签或不可变 commit,并提交 go.modgo.sum

构建契约

所有受支持的模块消费站点都使用相同的预览与构建命令:

hugo server --disableFastRender
hugo --gc --minify

后续步骤

  1. 完成基础配置
  2. 设置代码仓库、版权信息、Logo 和菜单。
  3. page.mdpage.zh.md 的形式并置译文。
  4. 添加并自定义内容
  5. 选择部署目标

开始之前

构建 OINK 站点的前提条件。

安装 Oink

为站点添加固定版本的 Oink Hugo Module。

从零新建站点

在没有前端工具链的情况下创建最小双语 OINK 站点。

站点基础配置

配置站点、语言、导航与本地功能。

查看双语项目站点

把独立 Oink 项目站点作为完整参考。

在容器中运行 OINK

使用 Hugo Extended 容器构建和预览 OINK 站点。

其他安装方式

使用 OINK 归档、Git checkout 或 Hugo Module。

故障排查与已知问题

诊断 Oink 安装、构建、语言与平台问题。