From 10d0fcc01f77b1edad16fbdd415825731f7419fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Mon, 22 May 2023 16:48:58 +0200 Subject: [PATCH] docs: Regen CLI docs --- docs/content/en/commands/hugo.md | 2 +- docs/content/en/commands/hugo_completion.md | 1 + .../en/commands/hugo_completion_bash.md | 1 + .../en/commands/hugo_completion_fish.md | 1 + .../en/commands/hugo_completion_powershell.md | 1 + .../en/commands/hugo_completion_zsh.md | 3 +- docs/content/en/commands/hugo_config.md | 31 ++--- .../content/en/commands/hugo_config_mounts.md | 3 +- docs/content/en/commands/hugo_convert.md | 37 +++--- .../en/commands/hugo_convert_toJSON.md | 3 +- .../en/commands/hugo_convert_toTOML.md | 3 +- .../en/commands/hugo_convert_toYAML.md | 3 +- docs/content/en/commands/hugo_deploy.md | 45 +++---- docs/content/en/commands/hugo_env.md | 8 +- docs/content/en/commands/hugo_gen.md | 5 + .../en/commands/hugo_gen_chromastyles.md | 3 +- docs/content/en/commands/hugo_gen_doc.md | 14 +-- docs/content/en/commands/hugo_gen_man.md | 7 +- docs/content/en/commands/hugo_import.md | 5 + .../content/en/commands/hugo_import_jekyll.md | 5 +- docs/content/en/commands/hugo_list.md | 35 +++--- docs/content/en/commands/hugo_list_all.md | 3 +- docs/content/en/commands/hugo_list_drafts.md | 3 +- docs/content/en/commands/hugo_list_expired.md | 3 +- docs/content/en/commands/hugo_list_future.md | 3 +- docs/content/en/commands/hugo_mod.md | 56 +++------ docs/content/en/commands/hugo_mod_clean.md | 9 +- docs/content/en/commands/hugo_mod_get.md | 3 +- docs/content/en/commands/hugo_mod_graph.md | 6 +- docs/content/en/commands/hugo_mod_init.md | 17 +-- docs/content/en/commands/hugo_mod_npm.md | 3 +- docs/content/en/commands/hugo_mod_npm_pack.md | 3 +- docs/content/en/commands/hugo_mod_tidy.md | 3 +- docs/content/en/commands/hugo_mod_vendor.md | 8 +- docs/content/en/commands/hugo_mod_verify.md | 4 +- docs/content/en/commands/hugo_new.md | 63 +++------- docs/content/en/commands/hugo_new_content.md | 56 +++++++++ docs/content/en/commands/hugo_new_site.md | 33 +++--- docs/content/en/commands/hugo_new_theme.md | 40 +++---- docs/content/en/commands/hugo_server.md | 112 +++++++++--------- docs/content/en/commands/hugo_version.md | 7 +- 41 files changed, 345 insertions(+), 306 deletions(-) create mode 100644 docs/content/en/commands/hugo_new_content.md diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index 0b42d5521a2..73d443169e6 100644 --- a/docs/content/en/commands/hugo.md +++ b/docs/content/en/commands/hugo.md @@ -82,5 +82,5 @@ hugo [flags] * [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo server](/commands/hugo_server/) - A high performance webserver -* [hugo version](/commands/hugo_version/) - Print the version number of Hugo +* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info diff --git a/docs/content/en/commands/hugo_completion.md b/docs/content/en/commands/hugo_completion.md index 5387f7aeda2..d7cc64cc2fb 100644 --- a/docs/content/en/commands/hugo_completion.md +++ b/docs/content/en/commands/hugo_completion.md @@ -26,6 +26,7 @@ See each sub-command's help for details on how to use the generated script. --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_completion_bash.md b/docs/content/en/commands/hugo_completion_bash.md index 22d9486477e..eb6fdd8d47a 100644 --- a/docs/content/en/commands/hugo_completion_bash.md +++ b/docs/content/en/commands/hugo_completion_bash.md @@ -49,6 +49,7 @@ hugo completion bash --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_completion_fish.md b/docs/content/en/commands/hugo_completion_fish.md index 48150704499..f81acb8afea 100644 --- a/docs/content/en/commands/hugo_completion_fish.md +++ b/docs/content/en/commands/hugo_completion_fish.md @@ -40,6 +40,7 @@ hugo completion fish [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_completion_powershell.md b/docs/content/en/commands/hugo_completion_powershell.md index 7e6abb9f475..5f900ec594a 100644 --- a/docs/content/en/commands/hugo_completion_powershell.md +++ b/docs/content/en/commands/hugo_completion_powershell.md @@ -37,6 +37,7 @@ hugo completion powershell [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_completion_zsh.md b/docs/content/en/commands/hugo_completion_zsh.md index 9612817e38d..fbe5c6ad4c4 100644 --- a/docs/content/en/commands/hugo_completion_zsh.md +++ b/docs/content/en/commands/hugo_completion_zsh.md @@ -18,7 +18,7 @@ to enable it. You can execute the following once: To load completions in your current shell session: - source <(hugo completion zsh); compdef _hugo hugo + source <(hugo completion zsh) To load completions for every new session, execute once: @@ -51,6 +51,7 @@ hugo completion zsh [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_config.md b/docs/content/en/commands/hugo_config.md index ca73bbe4b6a..7756465769c 100644 --- a/docs/content/en/commands/hugo_config.md +++ b/docs/content/en/commands/hugo_config.md @@ -12,31 +12,32 @@ Print the site configuration Print the site configuration, both default and custom settings. ``` -hugo config [flags] +hugo config [command] [flags] ``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for config - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + -h, --help help for config ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_config_mounts.md b/docs/content/en/commands/hugo_config_mounts.md index 825ddf1b591..9ec0a5e7fe9 100644 --- a/docs/content/en/commands/hugo_config_mounts.md +++ b/docs/content/en/commands/hugo_config_mounts.md @@ -8,7 +8,7 @@ url: /commands/hugo_config_mounts/ Print the configured file mounts ``` -hugo config mounts [flags] +hugo config mounts [flags] [args] ``` ### Options @@ -24,6 +24,7 @@ hugo config mounts [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_convert.md b/docs/content/en/commands/hugo_convert.md index e8015a5b5f7..c524334874a 100644 --- a/docs/content/en/commands/hugo_convert.md +++ b/docs/content/en/commands/hugo_convert.md @@ -13,30 +13,35 @@ Convert your content (e.g. front matter) to different formats. See convert's subcommands toJSON, toTOML and toYAML for more information. +``` +hugo convert [command] [flags] +``` + ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for convert - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -o, --output string filesystem path to write files to - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory - --unsafe enable less safe operations, please backup first + -h, --help help for convert + -o, --output string filesystem path to write files to + --unsafe enable less safe operations, please backup first ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_convert_toJSON.md b/docs/content/en/commands/hugo_convert_toJSON.md index 162c42d0a91..4b811f49e67 100644 --- a/docs/content/en/commands/hugo_convert_toJSON.md +++ b/docs/content/en/commands/hugo_convert_toJSON.md @@ -13,7 +13,7 @@ toJSON converts all front matter in the content directory to use JSON for the front matter. ``` -hugo convert toJSON [flags] +hugo convert toJSON [flags] [args] ``` ### Options @@ -29,6 +29,7 @@ hugo convert toJSON [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_convert_toTOML.md b/docs/content/en/commands/hugo_convert_toTOML.md index 50c0c9ebf23..19d847e9019 100644 --- a/docs/content/en/commands/hugo_convert_toTOML.md +++ b/docs/content/en/commands/hugo_convert_toTOML.md @@ -13,7 +13,7 @@ toTOML converts all front matter in the content directory to use TOML for the front matter. ``` -hugo convert toTOML [flags] +hugo convert toTOML [flags] [args] ``` ### Options @@ -29,6 +29,7 @@ hugo convert toTOML [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_convert_toYAML.md b/docs/content/en/commands/hugo_convert_toYAML.md index bf2d28421f4..1785d3ad8ab 100644 --- a/docs/content/en/commands/hugo_convert_toYAML.md +++ b/docs/content/en/commands/hugo_convert_toYAML.md @@ -13,7 +13,7 @@ toYAML converts all front matter in the content directory to use YAML for the front matter. ``` -hugo convert toYAML [flags] +hugo convert toYAML [flags] [args] ``` ### Options @@ -29,6 +29,7 @@ hugo convert toYAML [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_deploy.md b/docs/content/en/commands/hugo_deploy.md index 7b14c30ef4b..4bec6df50b3 100644 --- a/docs/content/en/commands/hugo_deploy.md +++ b/docs/content/en/commands/hugo_deploy.md @@ -16,38 +16,39 @@ documentation. ``` -hugo deploy [flags] +hugo deploy [flags] [args] ``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - --confirm ask for confirmation before making changes to the target - --dryRun dry run - -e, --environment string build environment - --force force upload of all files - -h, --help help for deploy - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --invalidateCDN invalidate the CDN cache listed in the deployment target (default true) - --maxDeletes int maximum # of files to delete, or -1 to disable (default 256) - --workers int number of workers to transfer files. (default 10) - -s, --source string filesystem path to read files relative from - --target string target deployment from deployments section in config file; defaults to the first one - --themesDir string filesystem path to themes directory + --confirm ask for confirmation before making changes to the target + --dryRun dry run + --force force upload of all files + -h, --help help for deploy + --invalidateCDN invalidate the CDN cache listed in the deployment target (default true) + --maxDeletes int maximum # of files to delete, or -1 to disable (default 256) + --target string target deployment from deployments section in config file; defaults to the first one + --workers int number of workers to transfer files. defaults to 10 (default 10) ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_env.md b/docs/content/en/commands/hugo_env.md index 632614d5066..296e6e00218 100644 --- a/docs/content/en/commands/hugo_env.md +++ b/docs/content/en/commands/hugo_env.md @@ -9,13 +9,10 @@ Print Hugo version and environment info ### Synopsis -Print Hugo version and environment info. This is useful in Hugo bug reports. - -If you add the -v flag, you will get a full dependency list. - +Print Hugo version and environment info. This is useful in Hugo bug reports ``` -hugo env [flags] +hugo env [flags] [args] ``` ### Options @@ -31,6 +28,7 @@ hugo env [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_gen.md b/docs/content/en/commands/hugo_gen.md index 281669b596c..71c6dfe4204 100644 --- a/docs/content/en/commands/hugo_gen.md +++ b/docs/content/en/commands/hugo_gen.md @@ -7,6 +7,10 @@ url: /commands/hugo_gen/ A collection of several useful generators. +``` +hugo gen [command] [flags] +``` + ### Options ``` @@ -20,6 +24,7 @@ A collection of several useful generators. --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_gen_chromastyles.md b/docs/content/en/commands/hugo_gen_chromastyles.md index ed434b1c794..9c41f717454 100644 --- a/docs/content/en/commands/hugo_gen_chromastyles.md +++ b/docs/content/en/commands/hugo_gen_chromastyles.md @@ -14,7 +14,7 @@ Generate CSS stylesheet for the Chroma code highlighter for a given style. This See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles ``` -hugo gen chromastyles [flags] +hugo gen chromastyles [flags] [args] ``` ### Options @@ -33,6 +33,7 @@ hugo gen chromastyles [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_gen_doc.md b/docs/content/en/commands/hugo_gen_doc.md index b6e6a99f2f9..59999fb7bed 100644 --- a/docs/content/en/commands/hugo_gen_doc.md +++ b/docs/content/en/commands/hugo_gen_doc.md @@ -10,15 +10,14 @@ Generate Markdown documentation for the Hugo CLI. ### Synopsis Generate Markdown documentation for the Hugo CLI. - -This command is, mostly, used to create up-to-date documentation -of Hugo's command-line interface for https://gohugo.io/. - -It creates one Markdown file per command with front matter suitable -for rendering in Hugo. + This command is, mostly, used to create up-to-date documentation + of Hugo's command-line interface for https://gohugo.io/. + + It creates one Markdown file per command with front matter suitable + for rendering in Hugo. ``` -hugo gen doc [flags] +hugo gen doc [flags] [args] ``` ### Options @@ -35,6 +34,7 @@ hugo gen doc [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_gen_man.md b/docs/content/en/commands/hugo_gen_man.md index c37ca242023..f2c40d71d3a 100644 --- a/docs/content/en/commands/hugo_gen_man.md +++ b/docs/content/en/commands/hugo_gen_man.md @@ -10,11 +10,11 @@ Generate man pages for the Hugo CLI ### Synopsis This command automatically generates up-to-date man pages of Hugo's -command-line interface. By default, it creates the man page files -in the "man" directory under the current directory. + command-line interface. By default, it creates the man page files + in the "man" directory under the current directory. ``` -hugo gen man [flags] +hugo gen man [flags] [args] ``` ### Options @@ -31,6 +31,7 @@ hugo gen man [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_import.md b/docs/content/en/commands/hugo_import.md index 70b182902a3..c9774f466ed 100644 --- a/docs/content/en/commands/hugo_import.md +++ b/docs/content/en/commands/hugo_import.md @@ -13,6 +13,10 @@ Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. +``` +hugo import [command] [flags] +``` + ### Options ``` @@ -26,6 +30,7 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_import_jekyll.md b/docs/content/en/commands/hugo_import_jekyll.md index ff0ff549b4b..4e4876d90e7 100644 --- a/docs/content/en/commands/hugo_import_jekyll.md +++ b/docs/content/en/commands/hugo_import_jekyll.md @@ -10,11 +10,11 @@ hugo import from Jekyll ### Synopsis hugo import from Jekyll. - + Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. ``` -hugo import jekyll [flags] +hugo import jekyll [flags] [args] ``` ### Options @@ -31,6 +31,7 @@ hugo import jekyll [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_list.md b/docs/content/en/commands/hugo_list.md index e2854c56801..6a3ec36d83d 100644 --- a/docs/content/en/commands/hugo_list.md +++ b/docs/content/en/commands/hugo_list.md @@ -11,30 +11,35 @@ Listing out various types of content Listing out various types of content. -List requires a subcommand, e.g. `hugo list drafts`. +List requires a subcommand, e.g. hugo list drafts + +``` +hugo list [command] [flags] +``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for list - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + -h, --help help for list ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_list_all.md b/docs/content/en/commands/hugo_list_all.md index a6f9f94d674..5ac8a7c359b 100644 --- a/docs/content/en/commands/hugo_list_all.md +++ b/docs/content/en/commands/hugo_list_all.md @@ -12,7 +12,7 @@ List all posts List all of the posts in your content directory, include drafts, future and expired pages. ``` -hugo list all [flags] +hugo list all [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list all [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_list_drafts.md b/docs/content/en/commands/hugo_list_drafts.md index 98c8a047cfe..601c7648fbe 100644 --- a/docs/content/en/commands/hugo_list_drafts.md +++ b/docs/content/en/commands/hugo_list_drafts.md @@ -12,7 +12,7 @@ List all drafts List all of the drafts in your content directory. ``` -hugo list drafts [flags] +hugo list drafts [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list drafts [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_list_expired.md b/docs/content/en/commands/hugo_list_expired.md index 89c10d50110..47a9cc369da 100644 --- a/docs/content/en/commands/hugo_list_expired.md +++ b/docs/content/en/commands/hugo_list_expired.md @@ -12,7 +12,7 @@ List all posts already expired List all of the posts in your content directory which has already expired. ``` -hugo list expired [flags] +hugo list expired [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list expired [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_list_future.md b/docs/content/en/commands/hugo_list_future.md index ca15b767356..5cbb86c7482 100644 --- a/docs/content/en/commands/hugo_list_future.md +++ b/docs/content/en/commands/hugo_list_future.md @@ -12,7 +12,7 @@ List all posts dated in the future List all of the posts in your content directory which will be posted in the future. ``` -hugo list future [flags] +hugo list future [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo list future [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod.md b/docs/content/en/commands/hugo_mod.md index 1df6df78e5e..ac7e16f254e 100644 --- a/docs/content/en/commands/hugo_mod.md +++ b/docs/content/en/commands/hugo_mod.md @@ -10,7 +10,6 @@ Various Hugo Modules helpers. ### Synopsis Various helpers to help manage the modules in your project's dependency graph. - Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git). This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor". @@ -26,53 +25,26 @@ See https://gohugo.io/hugo-modules/ for more information. ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories + -h, --help help for mod +``` + +### Options inherited from parent commands + +``` --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -c, --contentDir string filesystem path to content directory + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output -d, --destination string filesystem path to write files to - --disableKinds strings disable different kind of pages (home, RSS etc.) - --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. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for mod - --ignoreCache ignores the cache directory --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -l, --layoutDir string filesystem path to layout directory - --minify minify any supported output format (HTML, XML etc.) - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --panicOnWarning panic on first WARNING log - --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode -s, --source string filesystem path to read files relative from - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory - --trace file write trace to file (not useful in general) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_mod_clean.md b/docs/content/en/commands/hugo_mod_clean.md index b13b7c020b4..ad97610cd34 100644 --- a/docs/content/en/commands/hugo_mod_clean.md +++ b/docs/content/en/commands/hugo_mod_clean.md @@ -11,14 +11,8 @@ Delete the Hugo Module cache for the current project. Delete the Hugo Module cache for the current project. -Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo". - -Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc". - - - ``` -hugo mod clean [flags] +hugo mod clean [flags] [args] ``` ### Options @@ -36,6 +30,7 @@ hugo mod clean [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_get.md b/docs/content/en/commands/hugo_mod_get.md index 54eaa74deaf..21fa1f967f7 100644 --- a/docs/content/en/commands/hugo_mod_get.md +++ b/docs/content/en/commands/hugo_mod_get.md @@ -38,7 +38,7 @@ See https://gohugo.io/hugo-modules/ for more information. ``` -hugo mod get [flags] +hugo mod get [flags] [args] ``` ### Options @@ -54,6 +54,7 @@ hugo mod get [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_graph.md b/docs/content/en/commands/hugo_mod_graph.md index ba8898a6906..79ff3170f33 100644 --- a/docs/content/en/commands/hugo_mod_graph.md +++ b/docs/content/en/commands/hugo_mod_graph.md @@ -14,13 +14,14 @@ Note that for vendored modules, that is the version listed and not the one from ``` -hugo mod graph [flags] +hugo mod graph [flags] [args] ``` ### Options ``` - -h, --help help for graph + --clean delete module cache for dependencies that fail verification + -h, --help help for graph ``` ### Options inherited from parent commands @@ -30,6 +31,7 @@ hugo mod graph [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_init.md b/docs/content/en/commands/hugo_mod_init.md index 21aacf1315e..ad4501b6442 100644 --- a/docs/content/en/commands/hugo_mod_init.md +++ b/docs/content/en/commands/hugo_mod_init.md @@ -10,16 +10,16 @@ Initialize this project as a Hugo Module. ### Synopsis Initialize this project as a Hugo Module. -It will try to guess the module path, but you may help by passing it as an argument, e.g: - - hugo mod init github.com/gohugoio/testshortcodes - -Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module -inside a subfolder on GitHub, as one example. - + It will try to guess the module path, but you may help by passing it as an argument, e.g: + + hugo mod init github.com/gohugoio/testshortcodes + + Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module + inside a subfolder on GitHub, as one example. + ``` -hugo mod init [flags] +hugo mod init [flags] [args] ``` ### Options @@ -35,6 +35,7 @@ hugo mod init [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_npm.md b/docs/content/en/commands/hugo_mod_npm.md index 0a9a4386906..8e13a7294f7 100644 --- a/docs/content/en/commands/hugo_mod_npm.md +++ b/docs/content/en/commands/hugo_mod_npm.md @@ -12,7 +12,7 @@ Various npm helpers. Various npm (Node package manager) helpers. ``` -hugo mod npm [flags] +hugo mod npm [command] [flags] ``` ### Options @@ -28,6 +28,7 @@ hugo mod npm [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_npm_pack.md b/docs/content/en/commands/hugo_mod_npm_pack.md index 597b039ded1..aadac772be7 100644 --- a/docs/content/en/commands/hugo_mod_npm_pack.md +++ b/docs/content/en/commands/hugo_mod_npm_pack.md @@ -22,7 +22,7 @@ so this may/will change in future versions of Hugo. ``` -hugo mod npm pack [flags] +hugo mod npm pack [flags] [args] ``` ### Options @@ -38,6 +38,7 @@ hugo mod npm pack [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_tidy.md b/docs/content/en/commands/hugo_mod_tidy.md index 68279cf9b41..9c665f1c5ba 100644 --- a/docs/content/en/commands/hugo_mod_tidy.md +++ b/docs/content/en/commands/hugo_mod_tidy.md @@ -8,7 +8,7 @@ url: /commands/hugo_mod_tidy/ Remove unused entries in go.mod and go.sum. ``` -hugo mod tidy [flags] +hugo mod tidy [flags] [args] ``` ### Options @@ -24,6 +24,7 @@ hugo mod tidy [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_vendor.md b/docs/content/en/commands/hugo_mod_vendor.md index 1dab295cabd..42c04609a75 100644 --- a/docs/content/en/commands/hugo_mod_vendor.md +++ b/docs/content/en/commands/hugo_mod_vendor.md @@ -10,12 +10,11 @@ Vendor all module dependencies into the _vendor directory. ### Synopsis Vendor all module dependencies into the _vendor directory. - -If a module is vendored, that is where Hugo will look for it's dependencies. - + If a module is vendored, that is where Hugo will look for it's dependencies. + ``` -hugo mod vendor [flags] +hugo mod vendor [flags] [args] ``` ### Options @@ -31,6 +30,7 @@ hugo mod vendor [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_mod_verify.md b/docs/content/en/commands/hugo_mod_verify.md index 7ffab453ef2..9cddcbc25d1 100644 --- a/docs/content/en/commands/hugo_mod_verify.md +++ b/docs/content/en/commands/hugo_mod_verify.md @@ -11,9 +11,8 @@ Verify dependencies. Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded. - ``` -hugo mod verify [flags] +hugo mod verify [flags] [args] ``` ### Options @@ -30,6 +29,7 @@ hugo mod verify [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging diff --git a/docs/content/en/commands/hugo_new.md b/docs/content/en/commands/hugo_new.md index e0f58247be8..31d6f1f18ed 100644 --- a/docs/content/en/commands/hugo_new.md +++ b/docs/content/en/commands/hugo_new.md @@ -19,67 +19,38 @@ If archetypes are provided in your theme or site, they will be used. Ensure you run this within the root directory of your site. ``` -hugo new [path] [flags] +hugo new [command] [flags] ``` ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories + -h, --help help for new +``` + +### Options inherited from parent commands + +``` --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -c, --contentDir string filesystem path to content directory + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output -d, --destination string filesystem path to write files to - --disableKinds strings disable different kind of pages (home, RSS etc.) - --editor string edit new content with this editor, if provided - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages -e, --environment string build environment - -f, --force overwrite file if it already exists - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for new - --ignoreCache ignores the cache directory --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -k, --kind string content type to create - -l, --layoutDir string filesystem path to layout directory - --minify minify any supported output format (HTML, XML etc.) - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --panicOnWarning panic on first WARNING log - --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode -s, --source string filesystem path to read files relative from - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory - --trace file write trace to file (not useful in general) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site +* [hugo new content](/commands/hugo_new_content/) - Create new content for your site * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) -* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme +* [hugo new theme](/commands/hugo_new_theme/) - Create a new site (skeleton) diff --git a/docs/content/en/commands/hugo_new_content.md b/docs/content/en/commands/hugo_new_content.md new file mode 100644 index 00000000000..5ff63a20bb7 --- /dev/null +++ b/docs/content/en/commands/hugo_new_content.md @@ -0,0 +1,56 @@ +--- +title: "hugo new content" +slug: hugo_new_content +url: /commands/hugo_new_content/ +--- +## hugo new content + +Create new content for your site + +### Synopsis + +Create a new content file and automatically set the date and title. + It will guess which kind of file to create based on the path provided. + + You can also specify the kind with `-k KIND`. + + If archetypes are provided in your theme or site, they will be used. + + Ensure you run this within the root directory of your site. + +``` +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 +``` + +### Options inherited from parent commands + +``` + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO + +* [hugo new](/commands/hugo_new/) - Create new content for your site + diff --git a/docs/content/en/commands/hugo_new_site.md b/docs/content/en/commands/hugo_new_site.md index e594a997911..96bb51924a2 100644 --- a/docs/content/en/commands/hugo_new_site.md +++ b/docs/content/en/commands/hugo_new_site.md @@ -20,27 +20,28 @@ hugo new site [path] [flags] ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - --force init inside non-empty directory - -f, --format string config file format (default "toml") - -h, --help help for site - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + --force init inside non-empty directory + -f, --format string config file format (default "toml") + -h, --help help for site ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_new_theme.md b/docs/content/en/commands/hugo_new_theme.md index 48c374d9871..a4057e0f1b8 100644 --- a/docs/content/en/commands/hugo_new_theme.md +++ b/docs/content/en/commands/hugo_new_theme.md @@ -5,41 +5,41 @@ url: /commands/hugo_new_theme/ --- ## hugo new theme -Create a new theme +Create a new site (skeleton) ### Synopsis -Create a new theme (skeleton) called [name] in ./themes. -New theme is a skeleton. Please add content to the touched files. Add your -name to the copyright line in the license and adjust the theme.toml file -as you see fit. +Create a new site in the provided directory. +The new site will have the correct structure, but no content or theme yet. +Use `hugo new [contentPath]` to create new content. ``` -hugo new theme [name] [flags] +hugo new theme [path] [flags] ``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for theme - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + -h, --help help for theme ``` ### Options inherited from parent commands ``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --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) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_server.md b/docs/content/en/commands/hugo_server.md index f80bd496e15..27e12deb97d 100644 --- a/docs/content/en/commands/hugo_server.md +++ b/docs/content/en/commands/hugo_server.md @@ -23,73 +23,73 @@ and push the latest content to them. As most Hugo sites are built in a fraction of a second, you will be able to save and see your changes nearly instantly. ``` -hugo server [flags] +hugo server [flags] [args] ``` ### Options ``` - --appendPort append port to baseURL (default true) - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - --bind string interface to which the server will bind (default "127.0.0.1") - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories + --appendPort append port to baseURL (default true) + -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ + --bind string interface to which the server will bind (default "127.0.0.1") + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --cleanDestinationDir remove files from destination not found in static directories + -c, --contentDir string filesystem path to content directory + --disableBrowserError do not show build errors in the browser + --disableFastRender enables full re-renders on changes + --disableKinds strings disable different kind of pages (home, RSS etc.) + --disableLiveReload watch without enabling live browser reload on rebuild + --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages + --forceSyncStatic copy all files when static is changed. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -h, --help help for server + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) + --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") + --memstats string log memory usage to this file + --minify minify any supported output format (HTML, XML etc.) + --navigateToChanged navigate to changed content file on live browser reload + --noBuildLock don't create .hugo_build.lock file + --noChmod don't sync permission mode of files + --noHTTPCache prevent HTTP caching + --noTimes don't sync modification time of files + --panicOnWarning panic on first WARNING log + --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes + -p, --port int port on which the server will listen (default 1313) + --printI18nWarnings print missing translations + --printMemoryUsage print memory usage to screen at intervals + --printPathWarnings print warnings on duplicate target paths etc. + --printUnusedTemplates print warnings on unused templates. + --renderStaticToDisk serve static files from disk and dynamic files from memory + --renderToDisk serve all files from disk (default is from memory) + --templateMetrics display metrics about template executions + --templateMetricsHints calculate some improvement hints when combined with --templateMetrics + -t, --theme strings themes to use (located in /themes/THEMENAME/) + --trace file write trace to file (not useful in general) + -w, --watch watch filesystem for changes and recreate as needed (default true) +``` + +### Options inherited from parent commands + +``` --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -c, --contentDir string filesystem path to content directory + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output -d, --destination string filesystem path to write files to - --disableBrowserError do not show build errors in the browser - --disableFastRender enables full re-renders on changes - --disableKinds strings disable different kind of pages (home, RSS etc.) - --disableLiveReload watch without enabling live browser reload on rebuild - --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. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for server - --ignoreCache ignores the cache directory --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -l, --layoutDir string filesystem path to layout directory - --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) - --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") - --memstats string log memory usage to this file - --minify minify any supported output format (HTML, XML etc.) - --navigateToChanged navigate to changed content file on live browser reload - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noHTTPCache prevent HTTP caching - --noTimes don't sync modification time of files - --panicOnWarning panic on first WARNING log - --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes - -p, --port int port on which the server will listen (default 1313) - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. - --renderStaticToDisk serve static files from disk and dynamic files from memory - --renderToDisk serve all files from disk (default is from memory) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode -s, --source string filesystem path to read files relative from - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory - --trace file write trace to file (not useful in general) - -w, --watch watch filesystem for changes and recreate as needed (default true) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is hugo.yaml|json|toml) - --configDir string config dir (default "config") - --debug debug output - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --quiet build in quiet mode - -v, --verbose verbose output - --verboseLog verbose logging + -v, --verbose verbose output + --verboseLog verbose logging ``` ### SEE ALSO diff --git a/docs/content/en/commands/hugo_version.md b/docs/content/en/commands/hugo_version.md index bdef5bbd467..b78237bb738 100644 --- a/docs/content/en/commands/hugo_version.md +++ b/docs/content/en/commands/hugo_version.md @@ -5,14 +5,14 @@ url: /commands/hugo_version/ --- ## hugo version -Print the version number of Hugo +Print Hugo version and environment info ### Synopsis -All software has versions. This is Hugo's. +Print Hugo version and environment info. This is useful in Hugo bug reports. ``` -hugo version [flags] +hugo version [flags] [args] ``` ### Options @@ -28,6 +28,7 @@ hugo version [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging