docs: Regen CLI docs
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 3 Aug 2021 09:55:02 +0000 (11:55 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 3 Aug 2021 09:55:02 +0000 (11:55 +0200)
docs/content/en/commands/hugo.md
docs/content/en/commands/hugo_completion.md [new file with mode: 0644]
docs/content/en/commands/hugo_completion_bash.md [new file with mode: 0644]
docs/content/en/commands/hugo_completion_fish.md [new file with mode: 0644]
docs/content/en/commands/hugo_completion_powershell.md [new file with mode: 0644]
docs/content/en/commands/hugo_completion_zsh.md [new file with mode: 0644]

index 43d9e77b7e1c837e244889e569b2a2458c98cf3e..00d60be042b880ca55c39b13f437543bb2c8784a 100644 (file)
@@ -69,6 +69,7 @@ hugo [flags]
 ### SEE ALSO
 
 * [hugo check](/commands/hugo_check/)   - Contains some verification checks
+* [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
new file mode 100644 (file)
index 0000000..fdcb008
--- /dev/null
@@ -0,0 +1,48 @@
+---
+title: "hugo completion"
+slug: hugo_completion
+url: /commands/hugo_completion/
+---
+## hugo completion
+
+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.
+
+
+### Options
+
+```
+  -h, --help   help for completion
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              config file (default is path/config.yaml|json|toml)
+      --configDir string           config dir (default "config")
+      --debug                      debug output
+  -e, --environment string         build environment
+      --ignoreVendor               ignores any _vendor directory
+      --ignoreVendorPaths string   ignores any _vendor for module paths matching the given Glob pattern
+      --log                        enable Logging
+      --logFile string             log File path (if set, logging enabled automatically)
+      --quiet                      build in quiet mode
+  -s, --source string              filesystem path to read files relative from
+      --themesDir string           filesystem path to themes directory
+  -v, --verbose                    verbose output
+      --verboseLog                 verbose logging
+```
+
+### 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
+
diff --git a/docs/content/en/commands/hugo_completion_bash.md b/docs/content/en/commands/hugo_completion_bash.md
new file mode 100644 (file)
index 0000000..5ff7c0a
--- /dev/null
@@ -0,0 +1,62 @@
+---
+title: "hugo completion bash"
+slug: hugo_completion_bash
+url: /commands/hugo_completion_bash/
+---
+## hugo completion 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)
+
+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
+
+You will need to start a new shell for this setup to take effect.
+  
+
+```
+hugo completion bash
+```
+
+### Options
+
+```
+  -h, --help              help for bash
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              config file (default is path/config.yaml|json|toml)
+      --configDir string           config dir (default "config")
+      --debug                      debug output
+  -e, --environment string         build environment
+      --ignoreVendor               ignores any _vendor directory
+      --ignoreVendorPaths string   ignores any _vendor for module paths matching the given Glob pattern
+      --log                        enable Logging
+      --logFile string             log File path (if set, logging enabled automatically)
+      --quiet                      build in quiet mode
+  -s, --source string              filesystem path to read files relative from
+      --themesDir string           filesystem path to themes directory
+  -v, --verbose                    verbose output
+      --verboseLog                 verbose logging
+```
+
+### SEE ALSO
+
+* [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
new file mode 100644 (file)
index 0000000..aab77bf
--- /dev/null
@@ -0,0 +1,56 @@
+---
+title: "hugo completion fish"
+slug: hugo_completion_fish
+url: /commands/hugo_completion_fish/
+---
+## hugo completion 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
+
+To load completions for every new session, execute once:
+$ hugo completion fish > ~/.config/fish/completions/hugo.fish
+
+You will need to start a new shell for this setup to take effect.
+
+
+```
+hugo completion fish [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for fish
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              config file (default is path/config.yaml|json|toml)
+      --configDir string           config dir (default "config")
+      --debug                      debug output
+  -e, --environment string         build environment
+      --ignoreVendor               ignores any _vendor directory
+      --ignoreVendorPaths string   ignores any _vendor for module paths matching the given Glob pattern
+      --log                        enable Logging
+      --logFile string             log File path (if set, logging enabled automatically)
+      --quiet                      build in quiet mode
+  -s, --source string              filesystem path to read files relative from
+      --themesDir string           filesystem path to themes directory
+  -v, --verbose                    verbose output
+      --verboseLog                 verbose logging
+```
+
+### SEE ALSO
+
+* [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
new file mode 100644 (file)
index 0000000..dc8aadc
--- /dev/null
@@ -0,0 +1,54 @@
+---
+title: "hugo completion powershell"
+slug: hugo_completion_powershell
+url: /commands/hugo_completion_powershell/
+---
+## hugo completion 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
+
+To load completions for every new session, add the output of the above command
+to your powershell profile.
+
+
+```
+hugo completion powershell [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for powershell
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              config file (default is path/config.yaml|json|toml)
+      --configDir string           config dir (default "config")
+      --debug                      debug output
+  -e, --environment string         build environment
+      --ignoreVendor               ignores any _vendor directory
+      --ignoreVendorPaths string   ignores any _vendor for module paths matching the given Glob pattern
+      --log                        enable Logging
+      --logFile string             log File path (if set, logging enabled automatically)
+      --quiet                      build in quiet mode
+  -s, --source string              filesystem path to read files relative from
+      --themesDir string           filesystem path to themes directory
+  -v, --verbose                    verbose output
+      --verboseLog                 verbose logging
+```
+
+### SEE ALSO
+
+* [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
new file mode 100644 (file)
index 0000000..b3062b7
--- /dev/null
@@ -0,0 +1,61 @@
+---
+title: "hugo completion zsh"
+slug: hugo_completion_zsh
+url: /commands/hugo_completion_zsh/
+---
+## hugo completion 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
+
+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
+
+You will need to start a new shell for this setup to take effect.
+
+
+```
+hugo completion zsh [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for zsh
+      --no-descriptions   disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              config file (default is path/config.yaml|json|toml)
+      --configDir string           config dir (default "config")
+      --debug                      debug output
+  -e, --environment string         build environment
+      --ignoreVendor               ignores any _vendor directory
+      --ignoreVendorPaths string   ignores any _vendor for module paths matching the given Glob pattern
+      --log                        enable Logging
+      --logFile string             log File path (if set, logging enabled automatically)
+      --quiet                      build in quiet mode
+  -s, --source string              filesystem path to read files relative from
+      --themesDir string           filesystem path to themes directory
+  -v, --verbose                    verbose output
+      --verboseLog                 verbose logging
+```
+
+### SEE ALSO
+
+* [hugo completion](/commands/hugo_completion/)         - generate the autocompletion script for the specified shell
+