把 Hugo 带到中文世界

Hugo 中文文档 · 布道站

Hugo 官方文档全部 19 个一级章节、948 页的社区简体中文翻译(非官方),附英文原文链接,便于对照阅读。

获取 Hugo 技能包 → 从快速开始读起 查看源码

  • 884篇译文
  • 20个章节
  • 22个真实踩坑
  • MIT技能包许可

本站是社区维护的 Hugo 官方文档简体中文翻译(非官方,站点 https://hugozh.cn/),覆盖上游全部 19 个一级章节(含函数与方法参考、术语表):从入门、安装、配置,到内容管理、模板、渲染钩子、短代码、资源管道、模块、托管部署、命令、故障排查与速查。每一页都对应官方英文站点的一页,页面底部保留原文链接,方便随时对照核实。

译文由 亦幸 和 DeepSeek Harness 整理,仅供学习参考。Hugo 迭代较快,如与官方英文原文有出入,请以官方文档为准。

本站包含哪些内容

章节 内容
入门 快速开始、基本用法、目录结构
安装 发行版差异、各平台安装方式、源码构建
配置 配置文件与配置目录、级联、Markup、图像、安全等 33 个配置分区
内容管理 内容格式、前置元数据、页面包、分类法、菜单、短代码等
模板 模板查找顺序、新版模板系统、分页、RSS、站点地图、内建模板
渲染钩子 链接、图片、标题、代码块、引用块、表格、原样透传
短代码 短代码机制与全部内置短代码
Hugo Pipes 资源管道:Sass、PostCSS、JS 构建、打包、压缩、指纹
Hugo 模块 模块、主题组件、Node.js 依赖
托管与部署 hugo deploy、rclone、rsync 与 11 个托管平台
命令 全部 44 个 CLI 命令与选项
故障排查 常见问题、审计、弃用、日志、性能
速查 Glob 模式、Emoji 等速查内容
工具 编辑器、可视化 CMS、站内搜索、迁移工具
关于 简介、特性、许可、安全模型
参与贡献 参与开发、文档与主题的方式

完成度:截至本版,上游文档的全部一级章节均已翻译,并与上游页面 1:1 对应——包含 313 页函数参考、268 页方法参考、159 条术语表,以及速查、命令、配置等各章。未纳入正文的只有上游 news/(其索引页已译,无 news 正文)与 _common/ 文档片段目录(片段内容已随引用它的页面内联译出)。

阅读建议

  1. 完全没接触过 Hugo,从「快速开始」开始,十几分钟就能跑出一个站点。
  2. 已经在用 Hugo,可以直接跳到「配置」和「内容管理」。
  3. 遇到命令行参数不清楚时,查「命令」;写模板时查「模板」与「渲染钩子」。
  4. 「目录结构」解释了 content/、layouts/、assets/ 等目录各自的职责,是排查「文件放错位置」类问题的第一站。
  5. 构建报错或页面不符合预期时,先看「故障排查」。

翻译与术语约定

专有名词首次出现时以「中文(english)」形式标注,其后沿用同一译法,以保证全站一致。主要约定如下:

英文 本站译法 说明
front matter 前置元数据(front matter) 文件顶部用 +++/--- 包裹的元数据块,正文中亦直接写作 front matter
page bundle 页面包 把页面与其资源放在同一目录的组织方式
branch bundle 分支包 以 _index.md 为入口的页面包
leaf bundle 叶子包 以 index.md 为入口的页面包
shortcode 短代码(shortcode) 在内容中调用模板的函数式标记
archetype 原型(archetype) hugo new content 生成新文件时套用的模板
partial 局部模板(partial) 可被其他模板复用的模板片段
render hook 渲染钩子(render hook) 覆盖 Markdown 元素默认渲染方式的模板
taxonomy 分类法(taxonomy) 标签、分类等结构化归类机制
section section(内容区块) content/ 下的顶层目录,保留英文以免与「章节」混淆

如何构建本站

本站是一个自包含的 Hugo 项目:无需安装外部主题、无需联网,所有版式都在项目的 layouts/ 与 assets/ 目录中。

要求 Hugo 0.158 或更高版本(标准版即可,不需要 extended 版)。配置里使用的是 0.158 起生效的 locale 键;若你停留在更早的版本,请把 hugo.toml 中的 locale 改回 languageCode。

# 在项目根目录(即本文件所在的 hugo-docs-zh 目录)执行
hugo server          # 本地预览,默认地址 http://localhost:1313/
hugo server -D       # 连同草稿一起预览
hugo                 # 生成静态站点到 public/ 目录
hugo --minify        # 生成时压缩输出

部署到子路径(例如 https://hugozh.cn/docs/)时,请先修改 hugo.toml 中的 baseURL,否则站内绝对链接会指向错误位置。

版权与免责

  • 原文版权归 Hugo 项目及其文档贡献者所有,原文仓库为 gohugoio/hugoDocs。
  • 本站译文仅用于学习与交流,不构成对官方文档的替代。
  • 如果你是文档作者并希望调整或移除某处译文,请以官方文档为准并联系本站维护者处理。

技能包

把建站经验打包给 AI 编码代理:一份可复用的 Hugo 技能包,含 22 个真实踩坑、SEO、多主题、日期与短代码的参考手册。

动态

了解 Hugo 的最新消息与公告。

方法

在模板中使用这些方法:Page、Site、Pages、Resource、Menu 等对象上的方法。

函数

在模板与原型中使用的全部函数与方法。

入门

从零开始搭建并运行一个 Hugo 站点:快速开始、安装、基本用法、目录结构与配置。

内容管理

内容管理章节总览:内容格式、前置元数据、内容组织与页面资源。

命令

Hugo 命令行界面的整体结构与各命令索引。

托管与部署

把 Hugo 站点发布到托管平台或对象存储的部署指南。

Hugo Pipes

Hugo 的资源管道,用于转换与优化资源。

Hugo 模块

用模块管理站点的内容、呈现与行为,本章总览模块机制与相关页面。

模板

用模板把内容、资源与数据渲染为发布页面,并概述本章主题与阅读顺序。

渲染钩子

用模板覆盖 Markdown 元素到 HTML 的转换,逐类控制链接、图片、标题与代码块输出。

短代码

介绍 Hugo 内置与自定义短代码的机制、定界符、参数规则与模板位置。

配置

Hugo 配置的组织方式、配置文件与配置目录、按环境覆盖、合并策略与环境变量。

安装

Hugo 的发行版差异、各平台安装方式、从源码构建、验证安装与升级方法。

故障排查

构建与渲染异常时的排查方法、诊断工具与常见问题解答。

关于

介绍 Hugo 的定位与特性、隐私保护、许可说明与安全模型。

速查

Hugo 常用语法、配置与术语的速查索引。

工具

帮助你创建和管理站点的第三方工具。

参与贡献

参与 Hugo 项目的开发、文档与主题贡献。