Configure Hugo modules
Module configuration: top level
hugo.
module:
noProxy: none
noVendor: ""
private: '*.*'
proxy: direct
replacements: ""
workspace: "off"
[module]
noProxy = 'none'
noVendor = ''
private = '*.*'
proxy = 'direct'
replacements = ''
workspace = 'off'
{
"module": {
"noProxy": "none",
"noVendor": "",
"private": "*.*",
"proxy": "direct",
"replacements": "",
"workspace": "off"
}
}
- noVendor
- A optional Glob pattern matching module paths to skip when vendoring, e.g. “github.com/**”
- vendorClosest
- When enabled, we will pick the vendored module closest to the module using it. The default behavior is to pick the first. Note that there can still be only one dependency of a given module path, so once it is in use it cannot be redefined.
- proxy
- Defines the proxy server to use to download remote modules. Default is
direct
, which means “git clone” and similar. - noProxy
- Comma separated glob list matching paths that should not use the proxy configured above.
- private
- Comma separated glob list matching paths that should be treated as private.
- workspace
- The workspace file to use. This enables Go workspace mode. Note that this can also be set via OS env, e.g.
export HUGO_MODULE_WORKSPACE=/my/hugo.work
This only works with Go 1.18+. In Hugov0.109.0
we changed the default tooff
and we now resolve any relative work file names relative to the working directory. - replacements
- A comma-separated list of mappings from module paths to directories, e.g.
github.com/bep/my-theme -> ../..,github.com/bep/shortcodes -> /some/path
. This is mostly useful for temporary local development of a module, in which case you might want to save it as an environment variable, e.g:env HUGO_MODULE_REPLACEMENTS="github.com/bep/my-theme -> ../.."
. Relative paths are relative to themesDir. Absolute paths are allowed.
Note that the above terms maps directly to their counterparts in Go Modules. Some of these setting may be natural to set as OS environment variables. To set the proxy server to use, as an example:
env HUGO_MODULE_PROXY=https://proxy.example.org hugo
Module configuration: hugoVersion
If your module requires a particular version of Hugo to work, you can indicate that in the module
section and the user will be warned if using a too old/new version.
hugo.
module:
hugoVersion:
extended: false
max: ""
min: ""
[module]
[module.hugoVersion]
extended = false
max = ''
min = ''
{
"module": {
"hugoVersion": {
"extended": false,
"max": "",
"min": ""
}
}
}
Any of the above can be omitted.
- min
- The minimum Hugo version supported, e.g.
0.55.0
- max
- The maximum Hugo version supported, e.g.
0.55.0
- extended
- Whether the extended version of Hugo is required.
Module configuration: 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
- Can be either a valid Go Module module path, e.g.
github.com/gohugoio/myShortcodes
, or the directory name for the module as stored in your themes folder. - ignoreConfig
- If enabled, any module configuration file, e.g.
hugo.toml
, will not be loaded. Note that this will also stop the loading of any transitive module dependencies. - ignoreImports
- If enabled, module imports will not be followed.
- disable
- Set to
true
to disable the module while keeping any version info in thego.*
files. - noMounts
- Do not mount any folder in this import.
- noVendor
- Never vendor this import (only allowed in main project).
Module configuration: mounts
Default 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
- The source directory of the mount. For the main project, this can be either project-relative or absolute and even a symbolic link. For other modules it must be project-relative.
- target
- Where it should be mounted into Hugo’s virtual filesystem. It must start with one of Hugo’s component folders:
static
,content
,layouts
,data
,assets
,i18n
, orarchetypes
. E.g.content/blog
. - lang
- The language code, e.g. “en”. Only relevant for
content
mounts, andstatic
mounts when in multihost mode. - includeFiles (string or slice)
- One or more glob patterns matching files or directories to include. If
excludeFiles
is not set, the files matchingincludeFiles
will be the files mounted.
The glob patterns are matched to the file names starting from the source
root, they should have Unix styled slashes even on Windows, /
matches the mount root and **
can be used as a super-asterisk to match recursively down all directories, e.g /posts/**.jpg
.
The search is case-insensitive.
- excludeFiles (string or slice)
- One or more glob patterns matching files to exclude.
Example
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"
}
]
}
}