Skip to content

Commit

Permalink
cod: Regen CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Feb 28, 2022
1 parent fd0c1a5 commit 14915a0
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 37 deletions.
4 changes: 2 additions & 2 deletions docs/content/en/commands/hugo.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ hugo [flags]
--debug debug output
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
Expand Down Expand Up @@ -69,7 +69,7 @@ hugo [flags]

### SEE ALSO

* [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 convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
Expand Down
11 changes: 5 additions & 6 deletions docs/content/en/commands/hugo_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ url: /commands/hugo_completion/
---
## hugo completion

generate the autocompletion script for the specified shell
Generate the autocompletion script for the specified shell

### Synopsis


Generate the autocompletion script for hugo for the specified shell.
See each sub-command's help for details on how to use the generated script.

Expand Down Expand Up @@ -40,8 +39,8 @@ 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 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
* [hugo completion zsh](/commands/hugo_completion_zsh/) - generate the autocompletion script for zsh
* [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
* [hugo completion zsh](/commands/hugo_completion_zsh/) - Generate the autocompletion script for zsh

22 changes: 13 additions & 9 deletions docs/content/en/commands/hugo_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,31 @@ url: /commands/hugo_completion_bash/
---
## hugo completion bash

generate the autocompletion script for bash
Generate the autocompletion script for bash

### Synopsis


Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:
$ source <(hugo completion bash)

source <(hugo completion bash)

To load completions for every new session, execute once:
Linux:
$ hugo completion bash > /etc/bash_completion.d/hugo
MacOS:
$ hugo completion bash > /usr/local/etc/bash_completion.d/hugo

#### Linux:

hugo completion bash > /etc/bash_completion.d/hugo

#### macOS:

hugo completion bash > /usr/local/etc/bash_completion.d/hugo

You will need to start a new shell for this setup to take effect.


```
hugo completion bash
Expand Down Expand Up @@ -57,5 +61,5 @@ hugo completion bash

### SEE ALSO

* [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

11 changes: 6 additions & 5 deletions docs/content/en/commands/hugo_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@ url: /commands/hugo_completion_fish/
---
## hugo completion fish

generate the autocompletion script for fish
Generate the autocompletion script for fish

### Synopsis


Generate the autocompletion script for the fish shell.

To load completions in your current shell session:
$ hugo completion fish | source

hugo completion fish | source

To load completions for every new session, execute once:
$ hugo completion fish > ~/.config/fish/completions/hugo.fish

hugo completion fish > ~/.config/fish/completions/hugo.fish

You will need to start a new shell for this setup to take effect.

Expand Down Expand Up @@ -51,5 +52,5 @@ hugo completion fish [flags]

### SEE ALSO

* [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

8 changes: 4 additions & 4 deletions docs/content/en/commands/hugo_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ url: /commands/hugo_completion_powershell/
---
## hugo completion powershell

generate the autocompletion script for powershell
Generate the autocompletion script for powershell

### Synopsis


Generate the autocompletion script for powershell.

To load completions in your current shell session:
PS C:\> hugo completion powershell | Out-String | Invoke-Expression

hugo completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command
to your powershell profile.
Expand Down Expand Up @@ -49,5 +49,5 @@ hugo completion powershell [flags]

### SEE ALSO

* [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

19 changes: 11 additions & 8 deletions docs/content/en/commands/hugo_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,26 @@ url: /commands/hugo_completion_zsh/
---
## hugo completion zsh

generate the autocompletion script for zsh
Generate the autocompletion script for zsh

### Synopsis


Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc
echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions for every new session, execute once:
# Linux:
$ hugo completion zsh > "${fpath[1]}/_hugo"
# macOS:
$ hugo completion zsh > /usr/local/share/zsh/site-functions/_hugo

#### Linux:

hugo completion zsh > "${fpath[1]}/_hugo"

#### macOS:

hugo completion zsh > /usr/local/share/zsh/site-functions/_hugo

You will need to start a new shell for this setup to take effect.

Expand Down Expand Up @@ -56,5 +59,5 @@ hugo completion zsh [flags]

### SEE ALSO

* [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

2 changes: 1 addition & 1 deletion docs/content/en/commands/hugo_mod.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ See https://gohugo.io/hugo-modules/ for more information.
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for mod
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/commands/hugo_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ hugo new [path] [flags]
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--editor string edit new content with this editor, if provided
--enableGitInfo add Git revision, date and author info to the pages
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for new
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/commands/hugo_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ hugo server [flags]
--disableFastRender enables full re-renders on changes
--disableKinds strings disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild
--enableGitInfo add Git revision, date and author info to the pages
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for server
Expand Down

0 comments on commit 14915a0

Please sign in to comment.