HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio 加星
  • 关于
    • 本节内容
    • 介绍
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前置事项
    • 构建选项
    • 页面资源
    • 图像处理
    • 简码
    • 相关内容
    • 节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 介绍
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 节模板
    • 分类法模板
    • 术语模板
    • 部分模板
    • 内容视图模板
    • 简码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • 持续时间
    • 菜单
    • 菜单项
    • 页面
    • 分页器
    • 页面集
    • 资源
    • 简码
    • 站点
    • 分类法
    • 时间
  • 渲染钩子
    • 本节内容
    • 介绍
    • 块引用
    • 代码块
    • 标题
    • 图片
    • 链接
    • 直接传递
    • 表格
  • 简码
    • 本节内容
    • 评论
    • 详情
    • 图
    • Gist
    • 高亮
    • Instagram
    • 参数
    • 二维码
    • 引用
    • 相关引用
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 介绍
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后期处理
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹识别和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • CLI
  • 故障排除
    • 本节内容
    • 审计
    • 日志
    • 检查
    • 弃用
    • 性能
    • 常见问题解答
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
HUGO 模块

使用 Hugo 模块

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

前提条件

Hugo 模块的大部分命令需要安装较新版本(>= 1.18)的 Go(请参阅 https://golang.ac.cn/dl/)和相关的 VCS 客户端(例如 Git,请参阅 https://git-scm.cn/downloads/)。如果您的站点在 Netlify 上运行的版本“较旧”,您可能需要在“环境设置”中将 GO_VERSION 设置为 1.19 或更高版本。

有关 Go 模块的更多信息,请参阅

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

初始化新模块

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

hugo mod init github.com/<your_user>/<your_project>

另请参阅 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/myShortcodes@v1.0.7

另请参阅 CLI 文档。

在模块中进行更改和测试

在项目中导入的模块进行本地开发的一种方法是将 replace 指令添加到 go.mod 中带有源的本地目录

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

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

除了修改 go.mod 文件外,您还可以使用模块配置 replacements 选项。

打印依赖关系图

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

例如

hugo mod graph

github.com/bep/my-modular-site github.com/bep/hugotestmods/mymounts@v1.2.0
github.com/bep/my-modular-site github.com/bep/hugotestmods/mypartials@v1.0.7
github.com/bep/hugotestmods/mypartials@v1.0.7 github.com/bep/hugotestmods/myassets@v1.0.4
github.com/bep/hugotestmods/mypartials@v1.0.7 github.com/bep/hugotestmods/myv2@v1.0.0
DISABLED github.com/bep/my-modular-site github.com/spf13/hyde@v0.0.0-20190427180251-e36f5799b396
github.com/bep/my-modular-site github.com/bep/hugo-fresh@v1.0.1
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 内部的任何打包依赖项。如果你不使用打包,则不需要该标志。但是,现在服务器已设置为监视工作区中的文件和目录,你可以看到本地编辑的重新加载。

另请参阅

  • 配置 Hugo 模块
  • 主题组件
  • 主题

在本页中

  • 先决条件
  • 初始化新模块
  • 为主题使用模块
  • 更新模块
  • 在模块中进行和测试更改
  • 打印依赖关系图
  • 打包你的模块
  • 整理 go.mod,go.sum
  • 清理模块缓存
  • 模块工作区
上次更新时间:2025 年 1 月 16 日:将目录名称、文件名和文件路径格式化为代码 (8051ff818)
改进此页面
由 Hugo 作者 提供
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

你的公司?
 

Hugo 徽标的版权归 Steve Francia 2013–2025 所有。

Hugo Gopher 基于 Renée French 的原创作品。

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