github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/content/en/hugo-modules/use-modules.md
Bjørn Erik Pedersen 14e369b961 Squashed 'docs/' changes from 341ecabb2..988f7d5c2 
988f7d5c2 Document default `enableInlineShortcodes` value
0f604a345 Fix typo in 0.66.0 release note
26fc74fe3 How to access individual EXIF data tags
d5d3bad9a Fix localhost links
fa6921213 Update index.md
5bf558f78 Release 0.66.0
74ccdaaf5 Merge branch 'temp660'
75faa478b releaser: Add release notes to /docs for release of 0.66.0
c4a4a9922 docs: Regen CLI docs
0624ac198 Add build.UseResourceCacheWhen
58a8d7cd1 Add build options documentation
d926c595e fix typo
99713d44b resources: Add basic @import support to resources.PostCSS
224b96cf7 deploy: Implement include/exclude filters for deploy
eb1a00050 Adjusting description; WordPress with capitalized P
91d8efa22 Add another tool for migration from the Wordpress
a6938a4ac Adjust showcase description
a9c0a0a69 Adjust showcase
e5af08aa6 Adding Aether as a proposed showcase item.
0013daa34 Add hugo.IsProduction function
34c419ef3 tpl: Add math.Sqrt
5bdab0ebd Update minification.md
9039332e2 Hugo 0.65.3
1400caf3a Merge branch 'temp653'
9796bb337 releaser: Add release notes to /docs for release of 0.65.3
65b26598f Fix typo
23aa57d80 Fix crashes for 404 in IsAncestor etc.
42c54bc6c 0.65.2
67fd5c1f6 Merge branch 'temp652'
d820ac017 releaser: Add release notes to /docs for release of 0.65.2
51f0888ff Release 0.65.1
91e95260c releaser: Add release notes to /docs for release of 0.65.1
1880ebf05 fix broken link on internal.md
ffaa33889 Update migrations.md
de4d64675 Another tool for migration from Medium platform
90b178d77 releaser: Add release notes to /docs for release of 0.65.1
6925cda30 Handle corner case with rendering text as code in URL
3cb4b19dd Release 0.65.0
7a600cb99 Merge branch 'temp650'
ef9531ff6 releaser: Add release notes to /docs for release of 0.65.0
9bc19606f docs: Regenerate CLI docs
d4a886ed2 Add Page.GetTerms
a3bf273a5 fix broken link on use-modules.md
001f52f4e Fix mage URL in development.md
eef72e887 Merge commit '4b670bc8cc38103c2c60e5090c2f56bf30832b8d'
b18a76631 commands: Support "hugo mod get -u ./..."

git-subtree-dir: docs
git-subtree-split: 988f7d5c2d7a1d40ec2c8ab961cb5a4e41b5bd4c
2020-03-09 20:19:32 +01:00

3.4 KiB
Raw Blame History

title linktitle description date categories keywords menu weight sections_weight draft aliases toc
Use Hugo Modules Use Hugo Modules How to use Hugo Modules to build and manage your site. 2019-07-24
hugo modules
install
themes
source
organization
directories
usage
modules
docs
parent weight
modules 20
20 20 false
/themes/usage/
/themes/installing/
/installing-and-using-themes/
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.:

hugo mod init github.com/gohugoio/myShortcodes

Also see the CLI Doc.

Update Modules

Modules will be downloaded and added when you add them as imports to your configuration, see Module Imports.

To update or manage versions, you can use hugo mod get.

Some examples:

Update All Modules

hugo mod get -u

Update All Modules Recursively

{{< new-in "0.65.0" >}}

hugo mod get -u ./...

Update One Module

hugo mod get -u github.com/gohugoio/myShortcodes

Get a Specific Version

hugo mod get github.com/gohugoio/myShortcodes@v1.0.7

Also see the CLI Doc.

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:

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.

Vendor Your Modules

hugo mod vendor will write all the module depencies 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.

Tidy go.mod, go.sum

Run hugo mod tidy to remove unused entries in go.mod and go.sum.

Also see the CLI Doc.

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.

Also see the CLI Doc.