github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Regen CLI docs

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/content/en/commands/hugo.md
View file

@ -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

4
docs/content/en/commands/hugo_build.md
View file

@ -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

2
docs/content/en/commands/hugo_completion.md
View file

@ -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

6
docs/content/en/commands/hugo_config.md
View file

@ -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

2
docs/content/en/commands/hugo_config_mounts.md
View file

@ -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

6
docs/content/en/commands/hugo_convert.md
View file

@ -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

2
docs/content/en/commands/hugo_convert_toJSON.md
View file

@ -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

2
docs/content/en/commands/hugo_convert_toTOML.md
View file

@ -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

2
docs/content/en/commands/hugo_convert_toYAML.md
View file

@ -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

6
docs/content/en/commands/hugo_deploy.md
View file

@ -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

6
docs/content/en/commands/hugo_env.md
View file

@ -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

8
docs/content/en/commands/hugo_gen.md
View file

@ -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

2
docs/content/en/commands/hugo_gen_chromastyles.md
View file

@ -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

2
docs/content/en/commands/hugo_gen_doc.md
View file

@ -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

2
docs/content/en/commands/hugo_gen_man.md
View file

@ -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

6
docs/content/en/commands/hugo_import.md
View file

@ -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

2
docs/content/en/commands/hugo_import_jekyll.md
View file

@ -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

6
docs/content/en/commands/hugo_list.md
View file

@ -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

2
docs/content/en/commands/hugo_list_all.md
View file

@ -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

2
docs/content/en/commands/hugo_list_drafts.md
View file

@ -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

2
docs/content/en/commands/hugo_list_expired.md
View file

@ -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

2
docs/content/en/commands/hugo_list_future.md
View file

@ -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

2
docs/content/en/commands/hugo_list_published.md
View file

@ -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

4
docs/content/en/commands/hugo_mod.md
View file

@ -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.

2
docs/content/en/commands/hugo_mod_clean.md
View file

@ -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

2
docs/content/en/commands/hugo_mod_get.md
View file

@ -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

2
docs/content/en/commands/hugo_mod_graph.md
View file

@ -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

2
docs/content/en/commands/hugo_mod_init.md
View file

@ -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

2
docs/content/en/commands/hugo_mod_npm.md
View file

@ -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.

2
docs/content/en/commands/hugo_mod_tidy.md
View file

@ -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

2
docs/content/en/commands/hugo_mod_vendor.md
View file

@ -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

2
docs/content/en/commands/hugo_mod_verify.md
View file

@ -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

6
docs/content/en/commands/hugo_new.md
View file

@ -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)

4
docs/content/en/commands/hugo_new_content.md
View file

@ -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

2
docs/content/en/commands/hugo_new_site.md
View file

@ -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

2
docs/content/en/commands/hugo_new_theme.md
View file

@ -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

4
docs/content/en/commands/hugo_server.md
View file

@ -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.

2
docs/content/en/commands/hugo_server_trust.md
View file

@ -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

6
docs/content/en/commands/hugo_version.md
View file

@ -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