HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
CONTRIBUTE

开发

为 Hugo 的开发贡献力量。

简介

您可以通过以下方式为 Hugo 项目做出贡献:

  • 在 论坛 上回答问题
  • 改善 文档
  • 监控 问题队列
  • 创建或改进 主题
  • 修复 bug

请将文档问题和拉取请求提交到 文档仓库 。

如果您有关于增强功能或新功能的想法,请在 论坛 的“功能”类别中创建一个新主题。这将帮助您:

  • 确定此功能是否已存在
  • 衡量兴趣度
  • 完善概念

如果兴趣足够大,请 创建一个提案 。在项目负责人接受提案之前,请不要提交拉取请求。

有关为 Hugo 做出贡献的完整指南,请参阅[贡献指南]。

预备条件

要从源代码构建扩展版或扩展版/部署版,您必须:

  1. 安装 Git
  2. 安装 Go 1.23.0 或更高版本
  3. 安装 C 编译器,例如 GCC 或 Clang
  4. 如 Go 文档 中所述更新您的 PATH 环境变量

请参阅这些 详细说明 以在 Windows 上安装 GCC。

GitHub 工作流程

本节假设您具备 Go、Git 和 GitHub 的实践知识,并且能够在命令行上工作。

使用此工作流程来创建和提交拉取请求。

步骤 1
Fork 项目仓库 。
步骤 2
克隆您的 fork。
步骤 3
创建一个新的分支,并使用包含相应问题编号的描述性名称。

对于新功能:

git checkout -b feat/implement-some-feature-99999

对于 bug 修复:

git checkout -b fix/fix-some-bug-99999
步骤 4
进行更改。
步骤 5
编译并安装。

要编译和安装标准版:

go install

要编译和安装扩展版:

CGO_ENABLED=1 go install -tags extended

要编译和安装扩展版/部署版:

CGO_ENABLED=1 go install -tags extended,withdeploy
步骤 6
测试您的更改:
go test ./...
步骤 7
使用描述性提交消息提交您的更改:
  • 在第一行提供摘要,通常不超过 50 个字符,后跟一个空行。
  • 可选,提供详细说明,每行不超过 80 个字符,后跟一个空行。
  • 添加一个或多个“Fixes”或“Closes”关键字,每个关键字独占一行,引用此更改解决的 问题 。

例如:

git commit -m "tpl/strings: Create wrap function

The strings.Wrap function wraps a string into one or more lines,
splitting the string after the given number of characters, but not
splitting in the middle of a word.

Fixes #99998
Closes #99999"

有关详细信息,请参阅 提交消息指南 。

步骤 8
将新分支推送到您的文档存储库的 fork。
步骤 9
访问 项目仓库 并创建一个拉取请求 (PR)。
步骤 10
项目维护者将审查您的 PR,并可能请求更改。在维护者合并您的 PR 后,您可以删除您的分支。

从源代码构建

您可以在 Hugo 的任何开发历史阶段构建、安装和测试它。以下示例构建并安装 Hugo 的扩展版本。

要构建和安装最新版本:

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest

要构建和安装特定版本:

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/[email protected]

要构建和安装主分支上的最新提交:

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@master

要构建和安装特定提交:

CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@0851c17

See also

  • 文档
  • BSD
  • Git信息
  • Linux
  • Windows

On this page

  • 简介
  • 预备条件
  • GitHub 工作流程
  • 从源代码构建
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护