From 14915a0c32069ac5b318dd4a67017e27135fba91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Mon, 28 Feb 2022 08:12:35 +0100 Subject: cod: Regen CLI docs --- docs/content/en/commands/hugo.md | 4 ++-- docs/content/en/commands/hugo_completion.md | 11 +++++------ docs/content/en/commands/hugo_completion_bash.md | 22 +++++++++++++--------- docs/content/en/commands/hugo_completion_fish.md | 11 ++++++----- .../en/commands/hugo_completion_powershell.md | 8 ++++---- docs/content/en/commands/hugo_completion_zsh.md | 19 +++++++++++-------- docs/content/en/commands/hugo_mod.md | 2 +- docs/content/en/commands/hugo_new.md | 2 +- docs/content/en/commands/hugo_server.md | 2 +- 9 files changed, 44 insertions(+), 37 deletions(-) (limited to 'docs') diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index 0aa81719a..df32da793 100644 --- a/docs/content/en/commands/hugo.md +++ b/docs/content/en/commands/hugo.md @@ -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 @@ -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. diff --git a/docs/content/en/commands/hugo_completion.md b/docs/content/en/commands/hugo_completion.md index 944021d08..c5e70cdd7 100644 --- a/docs/content/en/commands/hugo_completion.md +++ b/docs/content/en/commands/hugo_completion.md @@ -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. @@ -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 diff --git a/docs/content/en/commands/hugo_completion_bash.md b/docs/content/en/commands/hugo_completion_bash.md index 4d5a69277..e83c39836 100644 --- a/docs/content/en/commands/hugo_completion_bash.md +++ b/docs/content/en/commands/hugo_completion_bash.md @@ -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 @@ -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 diff --git a/docs/content/en/commands/hugo_completion_fish.md b/docs/content/en/commands/hugo_completion_fish.md index 0d2387410..07f39b4ba 100644 --- a/docs/content/en/commands/hugo_completion_fish.md +++ b/docs/content/en/commands/hugo_completion_fish.md @@ -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. @@ -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 diff --git a/docs/content/en/commands/hugo_completion_powershell.md b/docs/content/en/commands/hugo_completion_powershell.md index ab45bbcc7..990f522e6 100644 --- a/docs/content/en/commands/hugo_completion_powershell.md +++ b/docs/content/en/commands/hugo_completion_powershell.md @@ -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. @@ -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 diff --git a/docs/content/en/commands/hugo_completion_zsh.md b/docs/content/en/commands/hugo_completion_zsh.md index 06fb7507e..7088d4d32 100644 --- a/docs/content/en/commands/hugo_completion_zsh.md +++ b/docs/content/en/commands/hugo_completion_zsh.md @@ -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. @@ -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 diff --git a/docs/content/en/commands/hugo_mod.md b/docs/content/en/commands/hugo_mod.md index afcda9823..66a076322 100644 --- a/docs/content/en/commands/hugo_mod.md +++ b/docs/content/en/commands/hugo_mod.md @@ -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 diff --git a/docs/content/en/commands/hugo_new.md b/docs/content/en/commands/hugo_new.md index a8b084963..36a841b96 100644 --- a/docs/content/en/commands/hugo_new.md +++ b/docs/content/en/commands/hugo_new.md @@ -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 diff --git a/docs/content/en/commands/hugo_server.md b/docs/content/en/commands/hugo_server.md index c224c4a52..cd9a85cac 100644 --- a/docs/content/en/commands/hugo_server.md +++ b/docs/content/en/commands/hugo_server.md @@ -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 -- cgit v1.2.3