Initialize Modules and Themes§

To use Hugo modules, you need to initialize your modules and themes first.

1hugo mod init example.com/user/blog
sh

Install Modules§

It’s quite simply to add a module into your site, just import the module path in configuration. Let’s take the example.com/user/module as an example.

1[module]
2[[module.imports]]
3    path = 'example.com/user/module'
toml

1module:
2  imports:
3  - path: example.com/user/module
yaml

1{
2   "module": {
3      "imports": [
4         {
5            "path": "example.com/user/module"
6         }
7      ]
8   }
9}
json

You’ll need to restart the Hugo server to load the module’s assets fully after installing modules.

Uninstall Modules§

To uninstall modules, you need to remove or comment the modules from the configuration file, and then execute hugo mod tidy.

1[[module.import]]
2# path = "example.com/user/module"
toml

1hugo mod tidy
sh

Upgrade Modules§

Upgrade all modules recursive:

1hugo mod get -u ./...
sh

Update the latest version¹ possible for a given module:

1hugo mod get -u example.com/user/module
sh

Upgrade a specific version¹:

1hugo mod get -u example.com/user/module@v1.0.0
sh

Tidy Modules§

The following command remove unused modules from go.mod and go.sum.

1hugo mod tidy
sh

Clean Modules Cache§

Delete the Hugo Module cache for the current site:

1hugo mod clean
sh

Print Modules Graph§

You may be interested in which modules the site imports and their dependencies.

1hugo mod graph
sh

1hugo mod graph | grep blog
sh