docs: Regen CLI docs

This commit is contained in:
Bjørn Erik Pedersen 2024-10-15 10:30:35 +02:00
parent 6e1c5b61b3
commit b7d62d76c5
No known key found for this signature in database
39 changed files with 76 additions and 72 deletions

View file

@ -5,7 +5,7 @@ url: /commands/hugo/
--- ---
## hugo ## hugo
hugo builds your site Build your site
### Synopsis ### Synopsis
@ -70,17 +70,17 @@ hugo [flags]
### SEE ALSO ### 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 completion](/commands/hugo_completion/) - Generate the autocompletion script for the specified shell
* [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo config](/commands/hugo_config/) - Display site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert front matter to another format
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider. * [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a cloud provider
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info * [hugo env](/commands/hugo_env/) - Display version and environment info
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles
* [hugo import](/commands/hugo_import/) - Import your site from others. * [hugo import](/commands/hugo_import/) - Import a site from another system
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - List content
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content
* [hugo server](/commands/hugo_server/) - A high performance webserver * [hugo server](/commands/hugo_server/) - Start the embedded web server
* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info * [hugo version](/commands/hugo_version/) - Display version

View file

@ -5,7 +5,7 @@ url: /commands/hugo_build/
--- ---
## hugo build ## hugo build
build builds your site Build your site
### Synopsis ### Synopsis
@ -70,5 +70,5 @@ hugo build [flags]
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - Build your site

View file

@ -39,7 +39,7 @@ See each sub-command's help for details on how to use the generated script.
### SEE ALSO ### 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 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 fish](/commands/hugo_completion_fish/) - Generate the autocompletion script for fish
* [hugo completion powershell](/commands/hugo_completion_powershell/) - Generate the autocompletion script for powershell * [hugo completion powershell](/commands/hugo_completion_powershell/) - Generate the autocompletion script for powershell

View file

@ -5,11 +5,11 @@ url: /commands/hugo_config/
--- ---
## hugo config ## hugo config
Print the site configuration Display site configuration
### Synopsis ### Synopsis
Print the site configuration, both default and custom settings. Display site configuration, both default and custom settings.
``` ```
hugo config [command] [flags] hugo config [command] [flags]
@ -48,6 +48,6 @@ hugo config [command] [flags]
### SEE ALSO ### 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 * [hugo config mounts](/commands/hugo_config_mounts/) - Print the configured file mounts

View file

@ -42,5 +42,5 @@ hugo config mounts [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo config](/commands/hugo_config/) - Display site configuration

View file

@ -5,11 +5,11 @@ url: /commands/hugo_convert/
--- ---
## hugo convert ## hugo convert
Convert your content to different formats Convert front matter to another format
### Synopsis ### 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. 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 ### 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 toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML * [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML * [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML

View file

@ -44,5 +44,5 @@ hugo convert toJSON [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert front matter to another format

View file

@ -44,5 +44,5 @@ hugo convert toTOML [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert front matter to another format

View file

@ -44,5 +44,5 @@ hugo convert toYAML [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert front matter to another format

View file

@ -5,11 +5,11 @@ url: /commands/hugo_deploy/
--- ---
## hugo deploy ## hugo deploy
Deploy your site to a Cloud provider. Deploy your site to a cloud provider
### Synopsis ### 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 See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed
documentation. documentation.
@ -52,5 +52,5 @@ hugo deploy [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - Build your site

View file

@ -5,11 +5,11 @@ url: /commands/hugo_env/
--- ---
## hugo env ## hugo env
Print Hugo version and environment info Display version and environment info
### Synopsis ### 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] hugo env [flags] [args]
@ -41,5 +41,5 @@ hugo env [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - Build your site

View file

@ -5,7 +5,11 @@ url: /commands/hugo_gen/
--- ---
## 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 ### Options
@ -33,7 +37,7 @@ A collection of several useful generators.
### SEE ALSO ### 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 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 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 * [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI

View file

@ -47,5 +47,5 @@ hugo gen chromastyles [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles

View file

@ -47,5 +47,5 @@ hugo gen doc [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles

View file

@ -44,5 +44,5 @@ hugo gen man [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - Generate documentation and syntax highlighting styles

View file

@ -5,11 +5,11 @@ url: /commands/hugo_import/
--- ---
## hugo import ## hugo import
Import your site from others. Import a site from another system
### Synopsis ### 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`. 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 ### 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 * [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll

View file

@ -44,5 +44,5 @@ hugo import jekyll [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo import](/commands/hugo_import/) - Import your site from others. * [hugo import](/commands/hugo_import/) - Import a site from another system

View file

@ -5,11 +5,11 @@ url: /commands/hugo_list/
--- ---
## hugo list ## hugo list
Listing out various types of content List content
### Synopsis ### Synopsis
Listing out various types of content. List content.
List requires a subcommand, e.g. hugo list drafts List requires a subcommand, e.g. hugo list drafts
@ -39,7 +39,7 @@ List requires a subcommand, e.g. hugo list drafts
### SEE ALSO ### 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 all](/commands/hugo_list_all/) - List all content
* [hugo list drafts](/commands/hugo_list_drafts/) - List draft content * [hugo list drafts](/commands/hugo_list_drafts/) - List draft content
* [hugo list expired](/commands/hugo_list_expired/) - List expired content * [hugo list expired](/commands/hugo_list_expired/) - List expired content

View file

@ -41,5 +41,5 @@ hugo list all [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - List content

View file

@ -41,5 +41,5 @@ hugo list drafts [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - List content

View file

@ -41,5 +41,5 @@ hugo list expired [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - List content

View file

@ -41,5 +41,5 @@ hugo list future [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - List content

View file

@ -41,5 +41,5 @@ hugo list published [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - List content

View file

@ -5,7 +5,7 @@ url: /commands/hugo_mod/
--- ---
## hugo mod ## hugo mod
Various Hugo Modules helpers. Manage modules
### Synopsis ### Synopsis
@ -48,7 +48,7 @@ See https://gohugo.io/hugo-modules/ for more information.
### SEE ALSO ### 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 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 get](/commands/hugo_mod_get/) - Resolves dependencies in your current Hugo Project.
* [hugo mod graph](/commands/hugo_mod_graph/) - Print a module dependency graph. * [hugo mod graph](/commands/hugo_mod_graph/) - Print a module dependency graph.

View file

@ -48,5 +48,5 @@ hugo mod clean [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -72,5 +72,5 @@ hugo mod get [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -49,5 +49,5 @@ hugo mod graph [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -53,5 +53,5 @@ hugo mod init [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -41,6 +41,6 @@ hugo mod npm [command] [flags]
### SEE ALSO ### 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. * [hugo mod npm pack](/commands/hugo_mod_npm_pack/) - Experimental: Prepares and writes a composite package.json file for your project.

View file

@ -42,5 +42,5 @@ hugo mod tidy [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -48,5 +48,5 @@ hugo mod vendor [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -47,5 +47,5 @@ hugo mod verify [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo mod](/commands/hugo_mod/) - Manage modules

View file

@ -5,7 +5,7 @@ url: /commands/hugo_new/
--- ---
## hugo new ## hugo new
Create new content for your site Create new content
### Synopsis ### Synopsis
@ -44,8 +44,8 @@ Ensure you run this within the root directory of your site.
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - Build your site
* [hugo new content](/commands/hugo_new_content/) - Create new content for 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 site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme (skeleton) * [hugo new theme](/commands/hugo_new_theme/) - Create a new theme (skeleton)

View file

@ -5,7 +5,7 @@ url: /commands/hugo_new_content/
--- ---
## hugo new content ## hugo new content
Create new content for your site Create new content
### Synopsis ### Synopsis
@ -56,5 +56,5 @@ hugo new content [path] [flags]
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content

View file

@ -45,5 +45,5 @@ hugo new site [path] [flags]
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content

View file

@ -44,5 +44,5 @@ hugo new theme [name] [flags]
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content

View file

@ -5,7 +5,7 @@ url: /commands/hugo_server/
--- ---
## hugo server ## hugo server
A high performance webserver Start the embedded web server
### Synopsis ### Synopsis
@ -94,6 +94,6 @@ hugo server [command] [flags]
### SEE ALSO ### 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. * [hugo server trust](/commands/hugo_server_trust/) - Install the local CA in the system trust store.

View file

@ -38,5 +38,5 @@ hugo server trust [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo server](/commands/hugo_server/) - A high performance webserver * [hugo server](/commands/hugo_server/) - Start the embedded web server

View file

@ -5,11 +5,11 @@ url: /commands/hugo_version/
--- ---
## hugo version ## hugo version
Print Hugo version and environment info Display version
### Synopsis ### 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] hugo version [flags] [args]
@ -41,5 +41,5 @@ hugo version [flags] [args]
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - Build your site