diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-05-22 16:48:58 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-05-22 16:48:58 +0200 |
commit | 10d0fcc01f77b1edad16fbdd415825731f7419fb (patch) | |
tree | d222047d6412e4d9ec7b2a6604efd47ceaf98247 /docs | |
parent | b95e15694006a16eee41024be88615bda62041cf (diff) |
docs: Regen CLI docs
Diffstat (limited to 'docs')
41 files changed, 345 insertions, 306 deletions
diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index 0b42d5521..73d443169 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 5387f7aed..d7cc64cc2 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 22d948647..eb6fdd8d4 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 481507044..f81acb8af 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 7e6abb9f4..5f900ec59 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 9612817e3..fbe5c6ad4 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 ca73bbe4b..775646576 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 825ddf1b5..9ec0a5e7f 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 e8015a5b5..c52433487 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 162c42d0a..4b811f49e 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 50c0c9ebf..19d847e90 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 bf2d28421..1785d3ad8 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 7b14c30ef..4bec6df50 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 632614d50..296e6e002 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 |