HUGO 模块

配置 Hugo 模块

模块配置：顶层

hugo.
      
module:
  noProxy: none
  noVendor: ""
  private: '*.*'
  proxy: direct
  replacements: ""
  vendorClosest: false
  workspace: "off"

[module]
  noProxy = 'none'
  noVendor = ''
  private = '*.*'
  proxy = 'direct'
  replacements = ''
  vendorClosest = false
  workspace = 'off'

{
   "module": {
      "noProxy": "none",
      "noVendor": "",
      "private": "*.*",
      "proxy": "direct",
      "replacements": "",
      "vendorClosest": false,
      "workspace": "off"
   }
}
noProxy
（string）以逗号分隔的 glob 列表，匹配不应使用上述配置的代理的路径。
noVendor
（string）一个可选的 Glob 模式，用于匹配在供应商化时要跳过的模块路径，例如“github.com/**”
private
（string）以逗号分隔的 glob 列表，匹配应视为私有的路径。
proxy
（string）定义用于下载远程模块的代理服务器。默认值为 direct，表示“git clone”等。
vendorClosest
（bool）启用后，我们将选择最接近使用它的模块的供应商模块。默认行为是选择第一个。请注意，给定的模块路径仍然只能有一个依赖项，因此一旦被使用，就不能重新定义。默认值为 false。
workspace
（string）要使用的工作区文件。这启用了 Go 工作区模式。请注意，也可以通过 OS env 设置，例如 export HUGO_MODULE_WORKSPACE=/my/hugo.work。这仅适用于 Go 1.18+。在 Hugo v0.109.0 中，我们将默认值更改为 off，现在我们解析相对于工作目录的任何相对工作文件名。
replacements
（string）从模块路径到目录的逗号分隔的映射列表，例如 github.com/bep/my-theme -> ../..,github.com/bep/shortcodes -> /some/path。这对于模块的临时本地开发非常有用，在这种情况下，您可能希望将其保存为环境变量，例如：env HUGO_MODULE_REPLACEMENTS="github.com/bep/my-theme -> ../.."。相对路径是相对于 themesDir 的。允许使用绝对路径。

请注意，上述术语直接映射到 Go Modules 中的对应项。其中一些设置可能很自然地设置为 OS 环境变量。例如，要设置要使用的代理服务器

env HUGO_MODULE_PROXY=https://proxy.example.org hugo

模块配置：hugoVersion

如果您的模块需要特定版本的 Hugo 才能工作，您可以在 module 部分中指示该版本，如果用户使用的版本太旧/太新，则会收到警告。

hugo.
      
module:
  hugoVersion:
    extended: false
    max: ""
    min: ""

[module]
  [module.hugoVersion]
    extended = false
    max = ''
    min = ''

{
   "module": {
      "hugoVersion": {
         "extended": false,
         "max": "",
         "min": ""
      }
   }
}

可以省略上述任何内容。

min
（string）支持的最低 Hugo 版本，例如 0.55.0
max
（string）支持的最大 Hugo 版本，例如 0.55.0
extended
（bool）是否需要 Hugo 的扩展版本。

模块配置：imports

hugo.
      
module:
  imports:
  - disable: false
    ignoreConfig: false
    ignoreImports: false
    path: github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v
  - path: my-shortcodes

[module]
  [[module.imports]]
    disable = false
    ignoreConfig = false
    ignoreImports = false
    path = 'github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v'
  [[module.imports]]
    path = 'my-shortcodes'

{
   "module": {
      "imports": [
         {
            "disable": false,
            "ignoreConfig": false,
            "ignoreImports": false,
            "path": "github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v"
         },
         {
            "path": "my-shortcodes"
         }
      ]
   }
}
path
可以是有效的 Go Module 模块路径，例如 github.com/gohugoio/myShortcodes，也可以是模块存储在您的 themes 目录中的目录名称。
ignoreConfig
如果启用，则不会加载任何模块配置文件，例如 hugo.toml。请注意，这也会停止加载任何传递模块依赖项。
ignoreImports
如果启用，则不会遵循模块导入。
disable
设置为 true 以禁用模块，同时保留 go.* 文件中的任何版本信息。
noMounts
不要在此导入中挂载任何目录。
noVendor
永远不要供应商化此导入（仅允许在主项目中）。

模块配置：mounts

默认挂载

hugo.
      
module:
  mounts:
  - source: content
    target: content
  - source: static
    target: static
  - source: layouts
    target: layouts
  - source: data
    target: data
  - source: assets
    target: assets
  - source: i18n
    target: i18n
  - source: archetypes
    target: archetypes

[module]
  [[module.mounts]]
    source = 'content'
    target = 'content'
  [[module.mounts]]
    source = 'static'
    target = 'static'
  [[module.mounts]]
    source = 'layouts'
    target = 'layouts'
  [[module.mounts]]
    source = 'data'
    target = 'data'
  [[module.mounts]]
    source = 'assets'
    target = 'assets'
  [[module.mounts]]
    source = 'i18n'
    target = 'i18n'
  [[module.mounts]]
    source = 'archetypes'
    target = 'archetypes'

{
   "module": {
      "mounts": [
         {
            "source": "content",
            "target": "content"
         },
         {
            "source": "static",
            "target": "static"
         },
         {
            "source": "layouts",
            "target": "layouts"
         },
         {
            "source": "data",
            "target": "data"
         },
         {
            "source": "assets",
            "target": "assets"
         },
         {
            "source": "i18n",
            "target": "i18n"
         },
         {
            "source": "archetypes",
            "target": "archetypes"
         }
      ]
   }
}
source
（string）挂载的源目录。对于主项目，这可以是相对于项目的路径，也可以是绝对路径。对于其他模块，它必须是相对于项目的路径。
target
（string）它应挂载到 Hugo 的虚拟文件系统中的位置。它必须以 Hugo 的组件目录之一开头：static、content、layouts、data、assets、i18n 或 archetypes。例如 content/blog。
disableWatch
v0.128.0 中的新增功能
（bool）是否禁用此挂载在监视模式下的监视。默认值为 false。
lang
（string）语言代码，例如“en”。仅与 content 挂载相关，以及在多主机模式下与 static 挂载相关。
includeFiles
（string 或 string slice）一个或多个 glob 模式，用于匹配要包含的文件或目录。如果未设置 excludeFiles，则匹配 includeFiles 的文件将是要挂载的文件。

glob 模式与从 source 根目录开始的文件名匹配，即使在 Windows 上也应使用 Unix 样式的斜杠，/ 匹配挂载根目录，** 可以用作超级星号来递归匹配所有目录，例如 /posts/**.jpg。

搜索不区分大小写。

excludeFiles
（string 或 string slice）一个或多个 glob 模式，用于匹配要排除的文件。

示例

hugo.
      
module:
  mounts:
  - excludeFiles: docs/*
    source: content
    target: content
  - source: node_modules
    target: assets
  - source: assets
    target: assets

[module]
  [[module.mounts]]
    excludeFiles = 'docs/*'
    source = 'content'
    target = 'content'
  [[module.mounts]]
    source = 'node_modules'
    target = 'assets'
  [[module.mounts]]
    source = 'assets'
    target = 'assets'

{
   "module": {
      "mounts": [
         {
            "excludeFiles": "docs/*",
            "source": "content",
            "target": "content"
         },
         {
            "source": "node_modules",
            "target": "assets"
         },
         {
            "source": "assets",
            "target": "assets"
         }
      ]
   }
}

另请参阅

上次更新时间：2025年1月16日: 将目录名、文件名和文件路径格式化为代码 (8051ff818)
改进此页面