Squashed 'docs/' changes from 1798dc0d5..1d5548d73

1d5548d73 build.cachebusters
3c966904d netlify: Hugo 0.112.5
b32c3a811 Bump min Go version to 1.19 when building from source (#2095)
9dea2d2f9 netlify: Hugo 0.112.4
b3fb4a1bc docs: Regenerate CLI docs
291ecd301 docs: Regen CLI docs
c886958e2 Merge commit 'd3927310d5b2404c3238f9b899db3329ea516490'

git-subtree-dir: docs
git-subtree-split: 1d5548d7355be39364404a67eee7186d5ea71930
This commit is contained in:
Bjørn Erik Pedersen 2023-06-01 10:51:24 +02:00
parent d3927310d5
commit dfb1895e4b
44 changed files with 111 additions and 64 deletions

View file

@ -39,7 +39,6 @@ hugo [flags]
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment -e, --environment string build environment
--forceSyncStatic copy all files when static is changed. --forceSyncStatic copy all files when static is changed.
--format string preferred file format (toml, yaml or json) (default "toml")
--gc enable to run some cleanup tasks (remove unused cache files) after the build --gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for hugo -h, --help help for hugo
--ignoreCache ignores the cache directory --ignoreCache ignores the cache directory

View file

@ -28,7 +28,6 @@ See each sub-command's help for details on how to use the generated script.
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -51,7 +51,6 @@ hugo completion bash
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -42,7 +42,6 @@ hugo completion fish [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -39,7 +39,6 @@ hugo completion powershell [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -53,7 +53,6 @@ hugo completion zsh [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -18,7 +18,12 @@ hugo config [command] [flags]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
--format string preferred file format (toml, yaml or json) (default "toml")
-h, --help help for config -h, --help help for config
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -30,7 +35,6 @@ hugo config [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -14,7 +14,11 @@ hugo config mounts [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
-h, --help help for mounts -h, --help help for mounts
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -26,7 +30,6 @@ hugo config mounts [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -34,7 +34,6 @@ hugo convert [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -31,7 +31,6 @@ hugo convert toJSON [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -31,7 +31,6 @@ hugo convert toTOML [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -31,7 +31,6 @@ hugo convert toYAML [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -41,7 +41,6 @@ hugo deploy [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo env [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -26,7 +26,6 @@ hugo gen [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -35,7 +35,6 @@ hugo gen chromastyles [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -36,7 +36,6 @@ hugo gen doc [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -33,7 +33,6 @@ hugo gen man [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -32,7 +32,6 @@ hugo import [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -33,7 +33,6 @@ hugo import jekyll [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -32,7 +32,6 @@ hugo list [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo list all [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo list drafts [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo list expired [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo list future [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -37,7 +37,6 @@ See https://gohugo.io/hugo-modules/ for more information.
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -19,8 +19,12 @@ hugo mod clean [flags] [args]
``` ```
--all clean entire module cache --all clean entire module cache
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
-h, --help help for clean -h, --help help for clean
--pattern string pattern matching module paths to clean (all if not set), e.g. "**hugo*" --pattern string pattern matching module paths to clean (all if not set), e.g. "**hugo*"
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -32,7 +36,6 @@ hugo mod clean [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -56,7 +56,6 @@ hugo mod get [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -20,8 +20,12 @@ hugo mod graph [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--clean delete module cache for dependencies that fail verification --clean delete module cache for dependencies that fail verification
-c, --contentDir string filesystem path to content directory
-h, --help help for graph -h, --help help for graph
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -33,7 +37,6 @@ hugo mod graph [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -25,7 +25,11 @@ hugo mod init [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
-h, --help help for init -h, --help help for init
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -37,7 +41,6 @@ hugo mod init [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo mod npm [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -28,7 +28,11 @@ hugo mod npm pack [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
-h, --help help for pack -h, --help help for pack
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -40,7 +44,6 @@ hugo mod npm pack [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -14,7 +14,11 @@ hugo mod tidy [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
-h, --help help for tidy -h, --help help for tidy
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -26,7 +30,6 @@ hugo mod tidy [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -20,7 +20,11 @@ hugo mod vendor [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
-h, --help help for vendor -h, --help help for vendor
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -32,7 +36,6 @@ hugo mod vendor [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -18,8 +18,12 @@ hugo mod verify [flags] [args]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--clean delete module cache for dependencies that fail verification --clean delete module cache for dependencies that fail verification
-c, --contentDir string filesystem path to content directory
-h, --help help for verify -h, --help help for verify
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -31,7 +35,6 @@ hugo mod verify [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -37,7 +37,6 @@ hugo new [command] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -25,10 +25,15 @@ hugo new content [path] [flags]
### Options ### Options
``` ```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
-c, --contentDir string filesystem path to content directory
--editor string edit new content with this editor, if provided --editor string edit new content with this editor, if provided
-f, --force overwrite file if it already exists -f, --force overwrite file if it already exists
--format string preferred file format (toml, yaml or json) (default "toml")
-h, --help help for content -h, --help help for content
-k, --kind string content type to create -k, --kind string content type to create
-t, --theme strings themes to use (located in /themes/THEMENAME/)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -40,7 +45,6 @@ hugo new content [path] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -20,7 +20,7 @@ hugo new site [path] [flags]
### Options ### Options
``` ```
--force init inside non-empty directory -f, --force init inside non-empty directory
-h, --help help for site -h, --help help for site
``` ```
@ -33,7 +33,6 @@ hugo new site [path] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -32,7 +32,6 @@ hugo new theme [path] [flags]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -82,7 +82,6 @@ hugo server [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -30,7 +30,6 @@ hugo version [flags] [args]
--debug debug output --debug debug output
-d, --destination string filesystem path to write files to -d, --destination string filesystem path to write files to
-e, --environment string build environment -e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging --log enable Logging
--logFile string log File path (if set, logging enabled automatically) --logFile string log File path (if set, logging enabled automatically)

View file

@ -499,6 +499,18 @@ The `build` configuration section contains global build-related configuration op
useResourceCacheWhen="fallback" useResourceCacheWhen="fallback"
writeStats = false writeStats = false
noJSConfigInAssets = false noJSConfigInAssets = false
[[build.cachebusters]]
source = "assets/watching/hugo_stats\\.json"
target = "styles\\.css"
[[build.cachebusters]]
source = "(postcss|tailwind)\\.config\\.js"
target = "css"
[[build.cachebusters]]
source = "assets/.*\\.(js|ts|jsx|tsx)"
target = "js"
[[build.cachebusters]]
source = "assets/.*\\.(.*)$"
target = "$1"
{{< /code-toggle >}} {{< /code-toggle >}}
@ -513,6 +525,40 @@ writeStats
noJSConfigInAssets noJSConfigInAssets
: Turn off writing a `jsconfig.json` into your `/assets` folder with mapping of imports from running [js.Build](https://gohugo.io/hugo-pipes/js). This file is intended to help with intellisense/navigation inside code editors such as [VS Code](https://code.visualstudio.com/). Note that if you do not use `js.Build`, no file will be written. : Turn off writing a `jsconfig.json` into your `/assets` folder with mapping of imports from running [js.Build](https://gohugo.io/hugo-pipes/js). This file is intended to help with intellisense/navigation inside code editors such as [VS Code](https://code.visualstudio.com/). Note that if you do not use `js.Build`, no file will be written.
cachebusters
: See [Configure Cache Busters](#configure-cache-busters)
## Configure Cache Busters
{{< new-in "0.112.0" >}}
The `build.cachebusters` configuration option was added to support development using Tailwind 3.x's JIT compiler where a `build` config may look like this:
{{< code-toggle file="hugo" >}}
[build]
writeStats = true
[[build.cachebusters]]
source = "assets/watching/hugo_stats\\.json"
target = "styles\\.css"
[[build.cachebusters]]
source = "(postcss|tailwind)\\.config\\.js"
target = "css"
[[build.cachebusters]]
source = "assets/.*\\.(js|ts|jsx|tsx)"
target = "js"
[[build.cachebusters]]
source = "assets/.*\\.(.*)$"
target = "$1"
{{< /code-toggle >}}
Some key points in the above are `writeStats = true`, which writes a `hugo_stats.json` file on each build with HTML classes etc. that's used in the rendered output. Changes to this file will trigger a rebuild of the `styles.css` file. You also need to add `hugo_stats.json` to Hugo's server watcher. See [Hugo Starter Tailwind Basic](https://github.com/bep/hugo-starter-tailwind-basic) for a running example.
source
: A regexp matching file(s) relative to one of the virtual component directories in Hugo, typically `assets/...`.
target
: A regexp matching the keys in the resource cache that should be expired when `source` changes. You can use the matching regexp groups from `source` in the expression, e.g. `$1`.
## Configure Server ## Configure Server
This is only relevant when running `hugo server`, and it allows to set HTTP headers during development, which allows you to test out your Content Security Policy and similar. The configuration format matches [Netlify's](https://docs.netlify.com/routing/headers/#syntax-for-the-netlify-configuration-file) with slightly more powerful [Glob matching](https://github.com/gobwas/glob): This is only relevant when running `hugo server`, and it allows to set HTTP headers during development, which allows you to test out your Content Security Policy and similar. The configuration format matches [Netlify's](https://docs.netlify.com/routing/headers/#syntax-for-the-netlify-configuration-file) with slightly more powerful [Glob matching](https://github.com/gobwas/glob):

View file

@ -3,7 +3,7 @@
To build Hugo from source you must: To build Hugo from source you must:
1. Install [Git] 1. Install [Git]
1. Install [Go] version 1.18 or later 1. Install [Go] version 1.19 or later
1. Update your PATH environment variable as described in the [Go documentation] 1. Update your PATH environment variable as described in the [Go documentation]
> The install directory is controlled by the GOPATH and GOBIN environment variables. If GOBIN is set, binaries are installed to that directory. If GOPATH is set, binaries are installed to the bin subdirectory of the first directory in the GOPATH list. Otherwise, binaries are installed to the bin subdirectory of the default GOPATH ($HOME/go or %USERPROFILE%\go). > The install directory is controlled by the GOPATH and GOBIN environment variables. If GOBIN is set, binaries are installed to that directory. If GOPATH is set, binaries are installed to the bin subdirectory of the first directory in the GOPATH list. Otherwise, binaries are installed to the bin subdirectory of the default GOPATH ($HOME/go or %USERPROFILE%\go).

View file

@ -3,7 +3,7 @@ publish = "public"
command = "hugo --gc --minify" command = "hugo --gc --minify"
[context.production.environment] [context.production.environment]
HUGO_VERSION = "0.112.3" HUGO_VERSION = "0.112.5"
HUGO_ENV = "production" HUGO_ENV = "production"
HUGO_ENABLEGITINFO = "true" HUGO_ENABLEGITINFO = "true"
@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true"
command = "hugo --gc --minify --enableGitInfo" command = "hugo --gc --minify --enableGitInfo"
[context.split1.environment] [context.split1.environment]
HUGO_VERSION = "0.112.3" HUGO_VERSION = "0.112.5"
HUGO_ENV = "production" HUGO_ENV = "production"
[context.deploy-preview] [context.deploy-preview]
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL" command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
[context.deploy-preview.environment] [context.deploy-preview.environment]
HUGO_VERSION = "0.112.3" HUGO_VERSION = "0.112.5"
[context.branch-deploy] [context.branch-deploy]
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL" command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
[context.branch-deploy.environment] [context.branch-deploy.environment]
HUGO_VERSION = "0.112.3" HUGO_VERSION = "0.112.5"
[context.next.environment] [context.next.environment]
HUGO_ENABLEGITINFO = "true" HUGO_ENABLEGITINFO = "true"