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 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
HUGO MODULES

使用 Hugo 模块

如何使用 Hugo 模块构建和管理您的站点。

先决条件

Most of the commands for Hugo Modules require a newer version (>= 1.18) of Go installed (see https://golang.org/dl/) and the relevant VCS client (e.g. Git, see https://git-scm.com/downloads/ ). If you have an “older” site running on Netlify, you may have to set GO_VERSION to 1.19 or newer in your Environment settings.

For more information about Go Modules, see:

  • https://go.dev/wiki/Modules
  • https://blog.golang.org/using-go-modules

初始化新的模块

使用 hugo mod init 初始化新的 Hugo 模块。如果它无法推测模块路径,则必须将其作为参数提供,例如:

hugo mod init github.com/<你的用户名>/<你的项目名>

另请参见 CLI 文档 。

将模块用于主题

将模块用于主题的最简单方法是在配置中导入它。

  1. 初始化 hugo 模块系统: hugo mod init github.com/<你的用户名>/<你的项目名>
  2. 导入主题:
hugo.
     
module:
  imports:
  - path: github.com/spf13/hyde
[module]
  [[module.imports]]
    path = 'github.com/spf13/hyde'
{
   "module": {
      "imports": [
         {
            "path": "github.com/spf13/hyde"
         }
      ]
   }
}

更新模块

当您将模块作为导入添加到配置中时,将下载并添加模块,请参见 模块导入 。

要更新或管理版本,可以使用 hugo mod get 。

一些示例:

更新所有模块

hugo mod get -u

递归更新所有模块

hugo mod get -u ./...

更新一个模块

hugo mod get -u github.com/gohugoio/myShortcodes

获取特定版本

hugo mod get github.com/gohugoio/[email protected]

另请参见 CLI 文档 。

在模块中进行和测试更改

在项目中导入的模块进行本地开发的一种方法是向 go.mod 中包含源代码的本地目录添加替换指令:

replace github.com/bep/hugotestmods/mypartials => /Users/bep/hugotestmods/mypartials

如果您正在运行 hugo server ,则配置将重新加载,并且 /Users/bep/hugotestmods/mypartials 将被添加到监视列表中。

您可以使用模块配置 replacements 选项,而不是修改 go.mod 文件。

打印依赖关系图

从相关的模块目录使用 hugo mod graph ,它将打印依赖关系图,包括供应商、模块替换或禁用状态。

例如:

hugo mod graph

github.com/bep/my-modular-site github.com/bep/hugotestmods/[email protected]
github.com/bep/my-modular-site github.com/bep/hugotestmods/[email protected]
github.com/bep/hugotestmods/[email protected] github.com/bep/hugotestmods/[email protected]
github.com/bep/hugotestmods/[email protected] github.com/bep/hugotestmods/[email protected]
DISABLED github.com/bep/my-modular-site github.com/spf13/[email protected]
github.com/bep/my-modular-site github.com/bep/[email protected]
github.com/bep/my-modular-site in-themesdir

另请参见 CLI 文档 。

供应商你的模块

hugo mod vendor 将把所有模块依赖项写入 _vendor 文件夹,然后该文件夹将用于所有后续构建。

请注意:

  • 您可以在模块树的任何级别运行 hugo mod vendor 。
  • 供应商不会存储存储在 themes 文件夹中的模块。
  • 大多数命令都接受 --ignoreVendorPaths 标志,然后它将不使用 _vendor 中与给定的 Glob 模式匹配的模块路径中的供应商模块。

另请参见 CLI 文档 。

整理 go.mod、go.sum

运行 hugo mod tidy 以删除 go.mod 和 go.sum 中未使用的条目。

另请参见 CLI 文档 。

清理模块缓存

运行 hugo mod clean 删除整个模块缓存。

请注意,您还可以使用 maxAge 配置 modules 缓存,请参见 文件缓存 。

另请参见 CLI 文档 。

模块工作区

工作区支持已在 Go 1.18 中添加,Hugo 在 v0.109.0 版本中获得了对它的稳定支持。

工作区的一个常见用例是简化带有其主题模块的站点的本地开发。

可以在 *.work 文件中配置工作区,并使用 module.workspace 设置激活它,对于此用途,通常通过 HUGO_MODULE_WORKSPACE 操作系统环境变量进行控制。

请参阅 Hugo Docs 存储库中的 hugo.work 文件以了解示例:

go 1.20

use .
use ../gohugoioTheme

使用 use 指令,列出您要处理的所有模块,并指向其相对位置。如上例所示,建议始终在列表中包含主项目(“.”)。

有了它,您可以启动启用该工作区的 Hugo 服务器:

HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"

上面的 --ignoreVendorPaths 标志用于忽略 _vendor 内的任何供应商依赖项。如果您不使用供应商,则不需要该标志。但是现在服务器已设置好,可以监视工作区中的文件和目录,您可以看到本地编辑已重新加载。

See also

  • 配置 Hugo 模块

On this page

  • 先决条件
  • 初始化新的模块
  • 将模块用于主题
  • 更新模块
  • 在模块中进行和测试更改
  • 打印依赖关系图
  • 供应商你的模块
  • 整理 go.mod、go.sum
  • 清理模块缓存
  • 模块工作区
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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护