Skip to content

Commit

Permalink
docs: Regen CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Oct 15, 2024
1 parent 05fc815 commit 7061107
Show file tree
Hide file tree
Showing 39 changed files with 76 additions and 72 deletions.
26 changes: 13 additions & 13 deletions content/en/commands/hugo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ url: /commands/hugo/
---
## hugo

hugo builds your site
Build your site

### Synopsis

Expand Down Expand Up @@ -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 changes: 2 additions & 2 deletions content/en/commands/hugo_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ url: /commands/hugo_build/
---
## hugo build

build builds your site
Build your site

### Synopsis

Expand Down Expand Up @@ -70,5 +70,5 @@ hugo build [flags]

### SEE ALSO

* [hugo](/commands/hugo/) - hugo builds your site
* [hugo](/commands/hugo/) - Build your site

2 changes: 1 addition & 1 deletion content/en/commands/hugo_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions content/en/commands/hugo_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_config_mounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions content/en/commands/hugo_convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions content/en/commands/hugo_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -52,5 +52,5 @@ hugo deploy [flags] [args]

### SEE ALSO

* [hugo](/commands/hugo/) - hugo builds your site
* [hugo](/commands/hugo/) - Build your site

6 changes: 3 additions & 3 deletions content/en/commands/hugo_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -41,5 +41,5 @@ hugo env [flags] [args]

### SEE ALSO

* [hugo](/commands/hugo/) - hugo builds your site
* [hugo](/commands/hugo/) - Build your site

8 changes: 6 additions & 2 deletions content/en/commands/hugo_gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_gen_chromastyles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_gen_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_gen_man.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions content/en/commands/hugo_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_import_jekyll.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 3 deletions content/en/commands/hugo_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_list_all.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_list_drafts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_list_expired.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_list_future.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_list_published.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 2 deletions content/en/commands/hugo_mod.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ url: /commands/hugo_mod/
---
## hugo mod

Various Hugo Modules helpers.
Manage modules

### Synopsis

Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_tidy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_vendor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion content/en/commands/hugo_mod_verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Loading

0 comments on commit 7061107

Please sign in to comment.