mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
efa74c5c6e
ac2c4a487 Update documentation for Ugly URLs (#1082) 88bdec17a Change 072.0 to 0.72.0 in release post's description 2aa7d7818 Update rss.md (#1104) c80677aeb Update quick-start.md (#1076) d04196bbd Minor spelling and capitalization fixes 837d2feba Fixed spelling mistake 67dc78e12 Update installing.md ce280c5d6 Update relurl.md bb4d0e703 Capitalization and Redirecting URL fixes e1fecada0 Update partials.md 1d99bb182 Typos and whitespacing issues fixed b20dba125 actually fix index function link this time f47d6f1e3 Fixing typos, whitespace issues and links dc82309b9 fix link to the index function 1eab0cbea add missing word (#1130) 9c3ee62ae more fixes e9bc5880a whitespace, typos and HTTPS fixes 93b806493 Add missing word to Module section 80ced9062 Display image on page bundles page. 727029b0a Update index.md 51fc48e4d Release 0.72.0 1ff68ac3b releaser: Add release notes to /docs for release of 0.72.0 f74a25b92 common/maps: Add Scratch.Values 2fd83db96 Add redirect support to the server bdfccf9f4 Fix typo in install instructions e12737ea6 Create SUPPORT.md git-subtree-dir: docs git-subtree-split: ac2c4a4871e90ddfb180f23704ce7ec9023529ca
142 lines
3.8 KiB
Markdown
142 lines
3.8 KiB
Markdown
---
|
|
title: Use Hugo Modules
|
|
linktitle: Use Hugo Modules
|
|
description: How to use Hugo Modules to build and manage your site.
|
|
date: 2019-07-24
|
|
categories: [hugo modules]
|
|
keywords: [install, themes, source, organization, directories,usage,modules]
|
|
menu:
|
|
docs:
|
|
parent: "modules"
|
|
weight: 20
|
|
weight: 20
|
|
sections_weight: 20
|
|
draft: false
|
|
aliases: [/themes/usage/,/themes/installing/,/installing-and-using-themes/]
|
|
toc: true
|
|
---
|
|
|
|
## Prerequisite
|
|
|
|
{{< gomodules-info >}}
|
|
|
|
|
|
|
|
## Initialize a New Module
|
|
|
|
Use `hugo mod init` to initialize a new Hugo Module. If it fails to guess the module path, you must provide it as an argument, e.g.:
|
|
|
|
```bash
|
|
hugo mod init github.com/gohugoio/myShortcodes
|
|
```
|
|
|
|
Also see the [CLI Doc](/commands/hugo_mod_init/).
|
|
|
|
## Use a Module for a Theme
|
|
The easiest way to use a Module for a theme is to import it in the config.
|
|
|
|
1. Initialize the hugo module system: `hugo mod init github.com/<your_user>/<your_project>`
|
|
2. Import the theme in your `config.toml`:
|
|
|
|
```toml
|
|
[module]
|
|
[[module.imports]]
|
|
path = "github.com/spf13/hyde/"
|
|
```
|
|
|
|
## Update Modules
|
|
|
|
Modules will be downloaded and added when you add them as imports to your configuration, see [Module Imports](/hugo-modules/configuration/#module-config-imports).
|
|
|
|
To update or manage versions, you can use `hugo mod get`.
|
|
|
|
Some examples:
|
|
|
|
### Update All Modules
|
|
|
|
```bash
|
|
hugo mod get -u
|
|
```
|
|
|
|
### Update All Modules Recursively
|
|
|
|
{{< new-in "0.65.0" >}}
|
|
|
|
```bash
|
|
hugo mod get -u ./...
|
|
```
|
|
|
|
### Update One Module
|
|
|
|
```bash
|
|
hugo mod get -u github.com/gohugoio/myShortcodes
|
|
```
|
|
### Get a Specific Version
|
|
|
|
```bash
|
|
hugo mod get github.com/gohugoio/myShortcodes@v1.0.7
|
|
```
|
|
|
|
Also see the [CLI Doc](/commands/hugo_mod_get/).
|
|
|
|
## Make and test changes in a module
|
|
|
|
One way to do local development of a module imported in a project is to add a replace directive to a local directory with the source in `go.mod`:
|
|
|
|
```bash
|
|
replace github.com/bep/hugotestmods/mypartials => /Users/bep/hugotestmods/mypartials
|
|
```
|
|
|
|
If you have the `hugo server` running, the configuration will be reloaded and `/Users/bep/hugotestmods/mypartials` put on the watch list.
|
|
|
|
|
|
## Print Dependency Graph
|
|
|
|
|
|
Use `hugo mod graph` from the relevant module directory and it will print the dependency graph, including vendoring, module replacement or disabled status.
|
|
|
|
E.g.:
|
|
|
|
```
|
|
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
|
|
|
|
```
|
|
|
|
Also see the [CLI Doc](/commands/hugo_mod_graph/).
|
|
|
|
## Vendor Your Modules
|
|
|
|
`hugo mod vendor` will write all the module dependencies to a `_vendor` folder, which will then be used for all subsequent builds.
|
|
|
|
Note that:
|
|
|
|
* You can run `hugo mod vendor` on any level in the module tree.
|
|
* Vendoring will not store modules stored in your `themes` folder.
|
|
* Most commands accept a `--ignoreVendor` flag, which will then run as if the none of the `_vendor` folders in the module tree existed.
|
|
|
|
Also see the [CLI Doc](/commands/hugo_mod_vendor/).
|
|
|
|
|
|
## Tidy go.mod, go.sum
|
|
|
|
Run `hugo mod tidy` to remove unused entries in `go.mod` and `go.sum`.
|
|
|
|
Also see the [CLI Doc](/commands/hugo_mod_clean/).
|
|
|
|
## Clean Module Cache
|
|
|
|
Run `hugo mod clean` to delete the entire modules cache.
|
|
|
|
Note that you can also configure the `modules` cache with a `maxAge`, see [File Caches](/hugo-modules/configuration/#configure-file-caches).
|
|
|
|
|
|
|
|
Also see the [CLI Doc](/commands/hugo_mod_clean/).
|