diff options
Diffstat (limited to 'content/en')
43 files changed, 107 insertions, 60 deletions
diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md index 8dbdd6231..73d443169 100644 --- a/content/en/commands/hugo.md +++ b/content/en/commands/hugo.md @@ -39,7 +39,6 @@ hugo [flags] --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages -e, --environment string build environment --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 -h, --help help for hugo --ignoreCache ignores the cache directory diff --git a/content/en/commands/hugo_completion.md b/content/en/commands/hugo_completion.md index 7ab87f800..d7cc64cc2 100644 --- a/content/en/commands/hugo_completion.md +++ b/content/en/commands/hugo_completion.md @@ -28,7 +28,6 @@ See each sub-command's help for details on how to use the generated script. --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_bash.md b/content/en/commands/hugo_completion_bash.md index a4d4d6f11..eb6fdd8d4 100644 --- a/content/en/commands/hugo_completion_bash.md +++ b/content/en/commands/hugo_completion_bash.md @@ -51,7 +51,6 @@ hugo completion bash --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_fish.md b/content/en/commands/hugo_completion_fish.md index 6fe2d7f16..f81acb8af 100644 --- a/content/en/commands/hugo_completion_fish.md +++ b/content/en/commands/hugo_completion_fish.md @@ -42,7 +42,6 @@ hugo completion fish [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_powershell.md b/content/en/commands/hugo_completion_powershell.md index 614023dbb..5f900ec59 100644 --- a/content/en/commands/hugo_completion_powershell.md +++ b/content/en/commands/hugo_completion_powershell.md @@ -39,7 +39,6 @@ hugo completion powershell [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_zsh.md b/content/en/commands/hugo_completion_zsh.md index 7e17bc96d..fbe5c6ad4 100644 --- a/content/en/commands/hugo_completion_zsh.md +++ b/content/en/commands/hugo_completion_zsh.md @@ -53,7 +53,6 @@ hugo completion zsh [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_config.md b/content/en/commands/hugo_config.md index 0c54f0e6d..1dbf4c0de 100644 --- a/content/en/commands/hugo_config.md +++ b/content/en/commands/hugo_config.md @@ -18,7 +18,12 @@ hugo config [command] [flags] ### Options ``` - -h, --help help for config + -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 + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -30,7 +35,6 @@ hugo config [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_config_mounts.md b/content/en/commands/hugo_config_mounts.md index 1019f5102..e4c4cf8c5 100644 --- a/content/en/commands/hugo_config_mounts.md +++ b/content/en/commands/hugo_config_mounts.md @@ -14,7 +14,11 @@ hugo config mounts [flags] [args] ### Options ``` - -h, --help help for mounts + -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 + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -26,7 +30,6 @@ hugo config mounts [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert.md b/content/en/commands/hugo_convert.md index 0c5384fbb..c52433487 100644 --- a/content/en/commands/hugo_convert.md +++ b/content/en/commands/hugo_convert.md @@ -34,7 +34,6 @@ hugo convert [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert_toJSON.md b/content/en/commands/hugo_convert_toJSON.md index 73c2fc303..4b811f49e 100644 --- a/content/en/commands/hugo_convert_toJSON.md +++ b/content/en/commands/hugo_convert_toJSON.md @@ -31,7 +31,6 @@ hugo convert toJSON [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert_toTOML.md b/content/en/commands/hugo_convert_toTOML.md index 9141eb1a2..19d847e90 100644 --- a/content/en/commands/hugo_convert_toTOML.md +++ b/content/en/commands/hugo_convert_toTOML.md @@ -31,7 +31,6 @@ hugo convert toTOML [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert_toYAML.md b/content/en/commands/hugo_convert_toYAML.md index a932921cf..1785d3ad8 100644 --- a/content/en/commands/hugo_convert_toYAML.md +++ b/content/en/commands/hugo_convert_toYAML.md @@ -31,7 +31,6 @@ hugo convert toYAML [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_deploy.md b/content/en/commands/hugo_deploy.md index 0531664dd..4bec6df50 100644 --- a/content/en/commands/hugo_deploy.md +++ b/content/en/commands/hugo_deploy.md @@ -41,7 +41,6 @@ hugo deploy [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_env.md b/content/en/commands/hugo_env.md index e001c6098..296e6e002 100644 --- a/content/en/commands/hugo_env.md +++ b/content/en/commands/hugo_env.md @@ -30,7 +30,6 @@ hugo env [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen.md b/content/en/commands/hugo_gen.md index b589e2e0f..71c6dfe42 100644 --- a/content/en/commands/hugo_gen.md +++ b/content/en/commands/hugo_gen.md @@ -26,7 +26,6 @@ hugo gen [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen_chromastyles.md b/content/en/commands/hugo_gen_chromastyles.md index 5ea23381d..9c41f7174 100644 --- a/content/en/commands/hugo_gen_chromastyles.md +++ b/content/en/commands/hugo_gen_chromastyles.md @@ -35,7 +35,6 @@ hugo gen chromastyles [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen_doc.md b/content/en/commands/hugo_gen_doc.md index 16593400a..59999fb7b 100644 --- a/content/en/commands/hugo_gen_doc.md +++ b/content/en/commands/hugo_gen_doc.md @@ -36,7 +36,6 @@ hugo gen doc [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen_man.md b/content/en/commands/hugo_gen_man.md index 3602dcc93..f2c40d71d 100644 --- a/content/en/commands/hugo_gen_man.md +++ b/content/en/commands/hugo_gen_man.md @@ -33,7 +33,6 @@ hugo gen man [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_import.md b/content/en/commands/hugo_import.md index ad4907d58..c9774f466 100644 --- a/content/en/commands/hugo_import.md +++ b/content/en/commands/hugo_import.md @@ -32,7 +32,6 @@ hugo import [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_import_jekyll.md b/content/en/commands/hugo_import_jekyll.md index 10d603bdf..4e4876d90 100644 --- a/content/en/commands/hugo_import_jekyll.md +++ b/content/en/commands/hugo_import_jekyll.md @@ -33,7 +33,6 @@ hugo import jekyll [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list.md b/content/en/commands/hugo_list.md index 10a8cf6cb..6a3ec36d8 100644 --- a/content/en/commands/hugo_list.md +++ b/content/en/commands/hugo_list.md @@ -32,7 +32,6 @@ hugo list [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_all.md b/content/en/commands/hugo_list_all.md index 8edd0a4d9..5ac8a7c35 100644 --- a/content/en/commands/hugo_list_all.md +++ b/content/en/commands/hugo_list_all.md @@ -30,7 +30,6 @@ hugo list all [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_drafts.md b/content/en/commands/hugo_list_drafts.md index 5ec870a5d..601c7648f 100644 --- a/content/en/commands/hugo_list_drafts.md +++ b/content/en/commands/hugo_list_drafts.md @@ -30,7 +30,6 @@ hugo list drafts [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_expired.md b/content/en/commands/hugo_list_expired.md index 3feae5640..47a9cc369 100644 --- a/content/en/commands/hugo_list_expired.md +++ b/content/en/commands/hugo_list_expired.md @@ -30,7 +30,6 @@ hugo list expired [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_future.md b/content/en/commands/hugo_list_future.md index 5b331b90b..5cbb86c74 100644 --- a/content/en/commands/hugo_list_future.md +++ b/content/en/commands/hugo_list_future.md @@ -30,7 +30,6 @@ hugo list future [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod.md b/content/en/commands/hugo_mod.md index 8621f30dd..ac7e16f25 100644 --- a/content/en/commands/hugo_mod.md +++ b/content/en/commands/hugo_mod.md @@ -37,7 +37,6 @@ See https://gohugo.io/hugo-modules/ for more information. --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_clean.md b/content/en/commands/hugo_mod_clean.md index 922fab2ab..7878fe178 100644 --- a/content/en/commands/hugo_mod_clean.md +++ b/content/en/commands/hugo_mod_clean.md @@ -18,9 +18,13 @@ hugo mod clean [flags] [args] ### Options ``` - --all clean entire module cache - -h, --help help for clean - --pattern string pattern matching module paths to clean (all if not set), e.g. "**hugo*" + --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 + --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 @@ -32,7 +36,6 @@ hugo mod clean [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_get.md b/content/en/commands/hugo_mod_get.md index d0d0f85d3..21fa1f967 100644 --- a/content/en/commands/hugo_mod_get.md +++ b/content/en/commands/hugo_mod_get.md @@ -56,7 +56,6 @@ hugo mod get [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_graph.md b/content/en/commands/hugo_mod_graph.md index da72a2a31..fa1d66602 100644 --- a/content/en/commands/hugo_mod_graph.md +++ b/content/en/commands/hugo_mod_graph.md @@ -20,8 +20,12 @@ hugo mod graph [flags] [args] ### Options ``` - --clean delete module cache for dependencies that fail verification - -h, --help help for graph + -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 + -c, --contentDir string filesystem path to content directory + -h, --help help for graph + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -33,7 +37,6 @@ hugo mod graph [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_init.md b/content/en/commands/hugo_mod_init.md index 7d5f77aa7..af1575b73 100644 --- a/content/en/commands/hugo_mod_init.md +++ b/content/en/commands/hugo_mod_init.md @@ -25,7 +25,11 @@ hugo mod init [flags] [args] ### Options ``` - -h, --help help for init + -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 + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -37,7 +41,6 @@ hugo mod init [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_npm.md b/content/en/commands/hugo_mod_npm.md index 12ec71b77..8e13a7294 100644 --- a/content/en/commands/hugo_mod_npm.md +++ b/content/en/commands/hugo_mod_npm.md @@ -30,7 +30,6 @@ hugo mod npm [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_npm_pack.md b/content/en/commands/hugo_mod_npm_pack.md index b923db82c..623649909 100644 --- a/content/en/commands/hugo_mod_npm_pack.md +++ b/content/en/commands/hugo_mod_npm_pack.md @@ -28,7 +28,11 @@ hugo mod npm pack [flags] [args] ### Options ``` - -h, --help help for pack + -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 + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -40,7 +44,6 @@ hugo mod npm pack [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_tidy.md b/content/en/commands/hugo_mod_tidy.md index 63cb52ca6..31558a55b 100644 --- a/content/en/commands/hugo_mod_tidy.md +++ b/content/en/commands/hugo_mod_tidy.md @@ -14,7 +14,11 @@ hugo mod tidy [flags] [args] ### Options ``` - -h, --help help for tidy + -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 + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -26,7 +30,6 @@ hugo mod tidy [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_vendor.md b/content/en/commands/hugo_mod_vendor.md index 9d9943c8a..42d19b36e 100644 --- a/content/en/commands/hugo_mod_vendor.md +++ b/content/en/commands/hugo_mod_vendor.md @@ -20,7 +20,11 @@ hugo mod vendor [flags] [args] ### Options ``` - -h, --help help for vendor + -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 + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -32,7 +36,6 @@ hugo mod vendor [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_verify.md b/content/en/commands/hugo_mod_verify.md index dd41f29fd..861ef5752 100644 --- a/content/en/commands/hugo_mod_verify.md +++ b/content/en/commands/hugo_mod_verify.md @@ -18,8 +18,12 @@ hugo mod verify [flags] [args] ### Options ``` - --clean delete module cache for dependencies that fail verification - -h, --help help for verify + -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 + -c, --contentDir string filesystem path to content directory + -h, --help help for verify + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -31,7 +35,6 @@ hugo mod verify [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_new.md b/content/en/commands/hugo_new.md index dd170eee5..31d6f1f18 100644 --- a/content/en/commands/hugo_new.md +++ b/content/en/commands/hugo_new.md @@ -37,7 +37,6 @@ hugo new [command] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_new_content.md b/content/en/commands/hugo_new_content.md index e26fa9459..fdacc6596 100644 --- a/content/en/commands/hugo_new_content.md +++ b/content/en/commands/hugo_new_content.md @@ -25,10 +25,15 @@ hugo new content [path] [flags] ### Options ``` - --editor string edit new content with this editor, if provided - -f, --force overwrite file if it already exists - -h, --help help for content - -k, --kind string content type to create + -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 + -f, --force overwrite file if it already exists + --format string preferred file format (toml, yaml or json) (default "toml") + -h, --help help for content + -k, --kind string content type to create + -t, --theme strings themes to use (located in /themes/THEMENAME/) ``` ### Options inherited from parent commands @@ -40,7 +45,6 @@ hugo new content [path] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_new_site.md b/content/en/commands/hugo_new_site.md index 803127de3..9409f1e28 100644 --- a/content/en/commands/hugo_new_site.md +++ b/content/en/commands/hugo_new_site.md @@ -20,7 +20,7 @@ hugo new site [path] [flags] ### Options ``` - --force init inside non-empty directory + -f, --force init inside non-empty directory -h, --help help for site ``` @@ -33,7 +33,6 @@ hugo new site [path] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_new_theme.md b/content/en/commands/hugo_new_theme.md index b1f1ea3ee..a4057e0f1 100644 --- a/content/en/commands/hugo_new_theme.md +++ b/content/en/commands/hugo_new_theme.md @@ -32,7 +32,6 @@ hugo new theme [path] [flags] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_server.md b/content/en/commands/hugo_server.md index 657a4eee4..27e12deb9 100644 --- a/content/en/commands/hugo_server.md +++ b/content/en/commands/hugo_server.md @@ -82,7 +82,6 @@ hugo server [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_version.md b/content/en/commands/hugo_version.md index 35b720153..b78237bb7 100644 --- a/content/en/commands/hugo_version.md +++ b/content/en/commands/hugo_version.md @@ -30,7 +30,6 @@ hugo version [flags] [args] --debug debug output -d, --destination string filesystem path to write files to -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 --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index 53b444bb6..2ab9e6a33 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -499,6 +499,18 @@ The `build` configuration section contains global build-related configuration op useResourceCacheWhen="fallback" writeStats = 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 >}} @@ -513,6 +525,40 @@ writeStats 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. +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 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): diff --git a/content/en/installation/common/05-build-from-source.md b/content/en/installation/common/05-build-from-source.md index a135de9fd..c0bd85515 100644 --- a/content/en/installation/common/05-build-from-source.md +++ b/content/en/installation/common/05-build-from-source.md @@ -3,7 +3,7 @@ To build Hugo from source you must: 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] > 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). |