mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
docs: Regen CLI docs
This commit is contained in:
parent
8d19850e2d
commit
bf738d2f43
6 changed files with 282 additions and 0 deletions
|
@ -69,6 +69,7 @@ hugo [flags]
|
||||||
### SEE ALSO
|
### SEE ALSO
|
||||||
|
|
||||||
* [hugo check](/commands/hugo_check/) - Contains some verification checks
|
* [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 config](/commands/hugo_config/) - Print the site configuration
|
||||||
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
|
||||||
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
|
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.
|
||||||
|
|
48
docs/content/en/commands/hugo_completion.md
Normal file
48
docs/content/en/commands/hugo_completion.md
Normal file
|
@ -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
|
||||||
|
|
62
docs/content/en/commands/hugo_completion_bash.md
Normal file
62
docs/content/en/commands/hugo_completion_bash.md
Normal file
|
@ -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
|
||||||
|
|
56
docs/content/en/commands/hugo_completion_fish.md
Normal file
56
docs/content/en/commands/hugo_completion_fish.md
Normal file
|
@ -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
|
||||||
|
|
54
docs/content/en/commands/hugo_completion_powershell.md
Normal file
54
docs/content/en/commands/hugo_completion_powershell.md
Normal file
|
@ -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
|
||||||
|
|
61
docs/content/en/commands/hugo_completion_zsh.md
Normal file
61
docs/content/en/commands/hugo_completion_zsh.md
Normal file
|
@ -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
|
||||||
|
|
Loading…
Reference in a new issue