docs: Regen CLI docs - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit b7d62d76c5b97d440910c6a40e1e86e7bbad4d82
DIR parent 6e1c5b61b3aa4cc4c973fb62bc419e9acf06ded2
HTML Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Tue, 15 Oct 2024 10:30:35 +0200
docs: Regen CLI docs
Diffstat:
M docs/content/en/commands/hugo.md | 26 +++++++++++++-------------
M docs/content/en/commands/hugo_buil… | 4 ++--
M docs/content/en/commands/hugo_comp… | 2 +-
M docs/content/en/commands/hugo_conf… | 6 +++---
M docs/content/en/commands/hugo_conf… | 2 +-
M docs/content/en/commands/hugo_conv… | 6 +++---
M docs/content/en/commands/hugo_conv… | 2 +-
M docs/content/en/commands/hugo_conv… | 2 +-
M docs/content/en/commands/hugo_conv… | 2 +-
M docs/content/en/commands/hugo_depl… | 6 +++---
M docs/content/en/commands/hugo_env.… | 6 +++---
M docs/content/en/commands/hugo_gen.… | 8 ++++++--
M docs/content/en/commands/hugo_gen_… | 2 +-
M docs/content/en/commands/hugo_gen_… | 2 +-
M docs/content/en/commands/hugo_gen_… | 2 +-
M docs/content/en/commands/hugo_impo… | 6 +++---
M docs/content/en/commands/hugo_impo… | 2 +-
M docs/content/en/commands/hugo_list… | 6 +++---
M docs/content/en/commands/hugo_list… | 2 +-
M docs/content/en/commands/hugo_list… | 2 +-
M docs/content/en/commands/hugo_list… | 2 +-
M docs/content/en/commands/hugo_list… | 2 +-
M docs/content/en/commands/hugo_list… | 2 +-
M docs/content/en/commands/hugo_mod.… | 4 ++--
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_mod_… | 2 +-
M docs/content/en/commands/hugo_new.… | 6 +++---
M docs/content/en/commands/hugo_new_… | 4 ++--
M docs/content/en/commands/hugo_new_… | 2 +-
M docs/content/en/commands/hugo_new_… | 2 +-
M docs/content/en/commands/hugo_serv… | 4 ++--
M docs/content/en/commands/hugo_serv… | 2 +-
M docs/content/en/commands/hugo_vers… | 6 +++---
39 files changed, 76 insertions(+), 72 deletions(-)
---
DIR diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md
@@ -5,7 +5,7 @@ url: /commands/hugo/
---
## hugo
-hugo builds your site
+Build your site
### Synopsis
@@ -70,17 +70,17 @@ hugo [flags]
### SEE ALSO
-* [hugo build](/commands/hugo_build/) - build builds your site
+* [hugo build](/commands/hugo_build/) - Build your site
* [hugo completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
-* [hugo config](/commands/hugo_config/) - Print the site configuration
-* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
-* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
-* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
-* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
-* [hugo import](/commands/hugo_import/) - Import your site from others.
-* [hugo list](/commands/hugo_list/) - Listing out various types of content
-* [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 Hugo version and environment info
+* [hugo config](/commands/hugo_config/) - Display site configuration
+* [hugo convert](/commands/hugo_convert/) - Convert front matter to another format
+* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a cloud provider
+* [hugo env](/commands/hugo_env/) - Display version and environment info
+* [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles
+* [hugo import](/commands/hugo_import/) - Import a site from another system
+* [hugo list](/commands/hugo_list/) - List content
+* [hugo mod](/commands/hugo_mod/) - Manage modules
+* [hugo new](/commands/hugo_new/) - Create new content
+* [hugo server](/commands/hugo_server/) - Start the embedded web server
+* [hugo version](/commands/hugo_version/) - Display version
DIR diff --git a/docs/content/en/commands/hugo_build.md b/docs/content/en/commands/hugo_build.md
@@ -5,7 +5,7 @@ url: /commands/hugo_build/
---
## hugo build
-build builds your site
+Build your site
### Synopsis
@@ -70,5 +70,5 @@ hugo build [flags]
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
DIR diff --git a/docs/content/en/commands/hugo_completion.md b/docs/content/en/commands/hugo_completion.md
@@ -39,7 +39,7 @@ See each sub-command's help for details on how to use the generated script.
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo completion bash](/commands/hugo_completion_bash/) - Generate the autocompletion script for bash
* [hugo completion fish](/commands/hugo_completion_fish/) - Generate the autocompletion script for fish
* [hugo completion powershell](/commands/hugo_completion_powershell/) - Generate the autocompletion script for powershell
DIR diff --git a/docs/content/en/commands/hugo_config.md b/docs/content/en/commands/hugo_config.md
@@ -5,11 +5,11 @@ url: /commands/hugo_config/
---
## hugo config
-Print the site configuration
+Display site configuration
### Synopsis
-Print the site configuration, both default and custom settings.
+Display site configuration, both default and custom settings.
```
hugo config [command] [flags]
@@ -48,6 +48,6 @@ hugo config [command] [flags]
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo config mounts](/commands/hugo_config_mounts/) - Print the configured file mounts
DIR diff --git a/docs/content/en/commands/hugo_config_mounts.md b/docs/content/en/commands/hugo_config_mounts.md
@@ -42,5 +42,5 @@ hugo config mounts [flags] [args]
### SEE ALSO
-* [hugo config](/commands/hugo_config/) - Print the site configuration
+* [hugo config](/commands/hugo_config/) - Display site configuration
DIR diff --git a/docs/content/en/commands/hugo_convert.md b/docs/content/en/commands/hugo_convert.md
@@ -5,11 +5,11 @@ url: /commands/hugo_convert/
---
## hugo convert
-Convert your content to different formats
+Convert front matter to another format
### Synopsis
-Convert your content (e.g. front matter) to different formats.
+Convert front matter to another format.
See convert's subcommands toJSON, toTOML and toYAML for more information.
@@ -41,7 +41,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
DIR diff --git a/docs/content/en/commands/hugo_convert_toJSON.md b/docs/content/en/commands/hugo_convert_toJSON.md
@@ -44,5 +44,5 @@ hugo convert toJSON [flags] [args]
### SEE ALSO
-* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
+* [hugo convert](/commands/hugo_convert/) - Convert front matter to another format
DIR diff --git a/docs/content/en/commands/hugo_convert_toTOML.md b/docs/content/en/commands/hugo_convert_toTOML.md
@@ -44,5 +44,5 @@ hugo convert toTOML [flags] [args]
### SEE ALSO
-* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
+* [hugo convert](/commands/hugo_convert/) - Convert front matter to another format
DIR diff --git a/docs/content/en/commands/hugo_convert_toYAML.md b/docs/content/en/commands/hugo_convert_toYAML.md
@@ -44,5 +44,5 @@ hugo convert toYAML [flags] [args]
### SEE ALSO
-* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
+* [hugo convert](/commands/hugo_convert/) - Convert front matter to another format
DIR diff --git a/docs/content/en/commands/hugo_deploy.md b/docs/content/en/commands/hugo_deploy.md
@@ -5,11 +5,11 @@ url: /commands/hugo_deploy/
---
## hugo deploy
-Deploy your site to a Cloud provider.
+Deploy your site to a cloud provider
### Synopsis
-Deploy your site to a Cloud provider.
+Deploy your site to a cloud provider
See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed
documentation.
@@ -52,5 +52,5 @@ hugo deploy [flags] [args]
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
DIR diff --git a/docs/content/en/commands/hugo_env.md b/docs/content/en/commands/hugo_env.md
@@ -5,11 +5,11 @@ url: /commands/hugo_env/
---
## hugo env
-Print Hugo version and environment info
+Display version and environment info
### Synopsis
-Print Hugo version and environment info. This is useful in Hugo bug reports
+Display version and environment info. This is useful in Hugo bug reports
```
hugo env [flags] [args]
@@ -41,5 +41,5 @@ hugo env [flags] [args]
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
DIR diff --git a/docs/content/en/commands/hugo_gen.md b/docs/content/en/commands/hugo_gen.md
@@ -5,7 +5,11 @@ url: /commands/hugo_gen/
---
## hugo gen
-A collection of several useful generators.
+Generate documentation and syntax highlighting styles
+
+### Synopsis
+
+Generate documentation for your project using Hugo's documentation engine, including syntax highlighting for various programming languages.
### Options
@@ -33,7 +37,7 @@ A collection of several useful generators.
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
DIR diff --git a/docs/content/en/commands/hugo_gen_chromastyles.md b/docs/content/en/commands/hugo_gen_chromastyles.md
@@ -47,5 +47,5 @@ hugo gen chromastyles [flags] [args]
### SEE ALSO
-* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
+* [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles
DIR diff --git a/docs/content/en/commands/hugo_gen_doc.md b/docs/content/en/commands/hugo_gen_doc.md
@@ -47,5 +47,5 @@ hugo gen doc [flags] [args]
### SEE ALSO
-* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
+* [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles
DIR diff --git a/docs/content/en/commands/hugo_gen_man.md b/docs/content/en/commands/hugo_gen_man.md
@@ -44,5 +44,5 @@ hugo gen man [flags] [args]
### SEE ALSO
-* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
+* [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles
DIR diff --git a/docs/content/en/commands/hugo_import.md b/docs/content/en/commands/hugo_import.md
@@ -5,11 +5,11 @@ url: /commands/hugo_import/
---
## hugo import
-Import your site from others.
+Import a site from another system
### Synopsis
-Import your site from other web site generators like Jekyll.
+Import a site from another system.
Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
@@ -39,6 +39,6 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
DIR diff --git a/docs/content/en/commands/hugo_import_jekyll.md b/docs/content/en/commands/hugo_import_jekyll.md
@@ -44,5 +44,5 @@ hugo import jekyll [flags] [args]
### SEE ALSO
-* [hugo import](/commands/hugo_import/) - Import your site from others.
+* [hugo import](/commands/hugo_import/) - Import a site from another system
DIR diff --git a/docs/content/en/commands/hugo_list.md b/docs/content/en/commands/hugo_list.md
@@ -5,11 +5,11 @@ url: /commands/hugo_list/
---
## hugo list
-Listing out various types of content
+List content
### Synopsis
-Listing out various types of content.
+List content.
List requires a subcommand, e.g. hugo list drafts
@@ -39,7 +39,7 @@ List requires a subcommand, e.g. hugo list drafts
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo list all](/commands/hugo_list_all/) - List all content
* [hugo list drafts](/commands/hugo_list_drafts/) - List draft content
* [hugo list expired](/commands/hugo_list_expired/) - List expired content
DIR diff --git a/docs/content/en/commands/hugo_list_all.md b/docs/content/en/commands/hugo_list_all.md
@@ -41,5 +41,5 @@ hugo list all [flags] [args]
### SEE ALSO
-* [hugo list](/commands/hugo_list/) - Listing out various types of content
+* [hugo list](/commands/hugo_list/) - List content
DIR diff --git a/docs/content/en/commands/hugo_list_drafts.md b/docs/content/en/commands/hugo_list_drafts.md
@@ -41,5 +41,5 @@ hugo list drafts [flags] [args]
### SEE ALSO
-* [hugo list](/commands/hugo_list/) - Listing out various types of content
+* [hugo list](/commands/hugo_list/) - List content
DIR diff --git a/docs/content/en/commands/hugo_list_expired.md b/docs/content/en/commands/hugo_list_expired.md
@@ -41,5 +41,5 @@ hugo list expired [flags] [args]
### SEE ALSO
-* [hugo list](/commands/hugo_list/) - Listing out various types of content
+* [hugo list](/commands/hugo_list/) - List content
DIR diff --git a/docs/content/en/commands/hugo_list_future.md b/docs/content/en/commands/hugo_list_future.md
@@ -41,5 +41,5 @@ hugo list future [flags] [args]
### SEE ALSO
-* [hugo list](/commands/hugo_list/) - Listing out various types of content
+* [hugo list](/commands/hugo_list/) - List content
DIR diff --git a/docs/content/en/commands/hugo_list_published.md b/docs/content/en/commands/hugo_list_published.md
@@ -41,5 +41,5 @@ hugo list published [flags] [args]
### SEE ALSO
-* [hugo list](/commands/hugo_list/) - Listing out various types of content
+* [hugo list](/commands/hugo_list/) - List content
DIR diff --git a/docs/content/en/commands/hugo_mod.md b/docs/content/en/commands/hugo_mod.md
@@ -5,7 +5,7 @@ url: /commands/hugo_mod/
---
## hugo mod
-Various Hugo Modules helpers.
+Manage modules
### Synopsis
@@ -48,7 +48,7 @@ See https://gohugo.io/hugo-modules/ for more information.
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo mod clean](/commands/hugo_mod_clean/) - Delete the Hugo Module cache for the current project.
* [hugo mod get](/commands/hugo_mod_get/) - Resolves dependencies in your current Hugo Project.
* [hugo mod graph](/commands/hugo_mod_graph/) - Print a module dependency graph.
DIR diff --git a/docs/content/en/commands/hugo_mod_clean.md b/docs/content/en/commands/hugo_mod_clean.md
@@ -48,5 +48,5 @@ hugo mod clean [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_mod_get.md b/docs/content/en/commands/hugo_mod_get.md
@@ -72,5 +72,5 @@ hugo mod get [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_mod_graph.md b/docs/content/en/commands/hugo_mod_graph.md
@@ -49,5 +49,5 @@ hugo mod graph [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_mod_init.md b/docs/content/en/commands/hugo_mod_init.md
@@ -53,5 +53,5 @@ hugo mod init [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_mod_npm.md b/docs/content/en/commands/hugo_mod_npm.md
@@ -41,6 +41,6 @@ hugo mod npm [command] [flags]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
* [hugo mod npm pack](/commands/hugo_mod_npm_pack/) - Experimental: Prepares and writes a composite package.json file for your project.
DIR diff --git a/docs/content/en/commands/hugo_mod_tidy.md b/docs/content/en/commands/hugo_mod_tidy.md
@@ -42,5 +42,5 @@ hugo mod tidy [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_mod_vendor.md b/docs/content/en/commands/hugo_mod_vendor.md
@@ -48,5 +48,5 @@ hugo mod vendor [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_mod_verify.md b/docs/content/en/commands/hugo_mod_verify.md
@@ -47,5 +47,5 @@ hugo mod verify [flags] [args]
### SEE ALSO
-* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
+* [hugo mod](/commands/hugo_mod/) - Manage modules
DIR diff --git a/docs/content/en/commands/hugo_new.md b/docs/content/en/commands/hugo_new.md
@@ -5,7 +5,7 @@ url: /commands/hugo_new/
---
## hugo new
-Create new content for your site
+Create new content
### Synopsis
@@ -44,8 +44,8 @@ Ensure you run this within the root directory of your site.
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
-* [hugo new content](/commands/hugo_new_content/) - Create new content for your site
+* [hugo](/commands/hugo/) - Build your site
+* [hugo new content](/commands/hugo_new_content/) - Create new content
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme (skeleton)
DIR diff --git a/docs/content/en/commands/hugo_new_content.md b/docs/content/en/commands/hugo_new_content.md
@@ -5,7 +5,7 @@ url: /commands/hugo_new_content/
---
## hugo new content
-Create new content for your site
+Create new content
### Synopsis
@@ -56,5 +56,5 @@ hugo new content [path] [flags]
### SEE ALSO
-* [hugo new](/commands/hugo_new/) - Create new content for your site
+* [hugo new](/commands/hugo_new/) - Create new content
DIR diff --git a/docs/content/en/commands/hugo_new_site.md b/docs/content/en/commands/hugo_new_site.md
@@ -45,5 +45,5 @@ hugo new site [path] [flags]
### SEE ALSO
-* [hugo new](/commands/hugo_new/) - Create new content for your site
+* [hugo new](/commands/hugo_new/) - Create new content
DIR diff --git a/docs/content/en/commands/hugo_new_theme.md b/docs/content/en/commands/hugo_new_theme.md
@@ -44,5 +44,5 @@ hugo new theme [name] [flags]
### SEE ALSO
-* [hugo new](/commands/hugo_new/) - Create new content for your site
+* [hugo new](/commands/hugo_new/) - Create new content
DIR diff --git a/docs/content/en/commands/hugo_server.md b/docs/content/en/commands/hugo_server.md
@@ -5,7 +5,7 @@ url: /commands/hugo_server/
---
## hugo server
-A high performance webserver
+Start the embedded web server
### Synopsis
@@ -94,6 +94,6 @@ hugo server [command] [flags]
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site
* [hugo server trust](/commands/hugo_server_trust/) - Install the local CA in the system trust store.
DIR diff --git a/docs/content/en/commands/hugo_server_trust.md b/docs/content/en/commands/hugo_server_trust.md
@@ -38,5 +38,5 @@ hugo server trust [flags] [args]
### SEE ALSO
-* [hugo server](/commands/hugo_server/) - A high performance webserver
+* [hugo server](/commands/hugo_server/) - Start the embedded web server
DIR diff --git a/docs/content/en/commands/hugo_version.md b/docs/content/en/commands/hugo_version.md
@@ -5,11 +5,11 @@ url: /commands/hugo_version/
---
## hugo version
-Print Hugo version and environment info
+Display version
### Synopsis
-Print Hugo version and environment info. This is useful in Hugo bug reports.
+Display version and environment info. This is useful in Hugo bug reports.
```
hugo version [flags] [args]
@@ -41,5 +41,5 @@ hugo version [flags] [args]
### SEE ALSO
-* [hugo](/commands/hugo/) - hugo builds your site
+* [hugo](/commands/hugo/) - Build your site