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 May 22, 2023
1 parent b95e156 commit 10d0fcc
Show file tree
Hide file tree
Showing 41 changed files with 345 additions and 306 deletions.
2 changes: 1 addition & 1 deletion docs/content/en/commands/hugo.md
Expand Up @@ -82,5 +82,5 @@ hugo [flags]
* [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 the version number of Hugo
* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info

1 change: 1 addition & 0 deletions docs/content/en/commands/hugo_completion.md
Expand Up @@ -26,6 +26,7 @@ See each sub-command's help for details on how to use the generated script.
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
1 change: 1 addition & 0 deletions docs/content/en/commands/hugo_completion_bash.md
Expand Up @@ -49,6 +49,7 @@ hugo completion bash
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
1 change: 1 addition & 0 deletions docs/content/en/commands/hugo_completion_fish.md
Expand Up @@ -40,6 +40,7 @@ hugo completion fish [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
1 change: 1 addition & 0 deletions docs/content/en/commands/hugo_completion_powershell.md
Expand Up @@ -37,6 +37,7 @@ hugo completion powershell [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/commands/hugo_completion_zsh.md
Expand Up @@ -18,7 +18,7 @@ to enable it. You can execute the following once:

To load completions in your current shell session:

source <(hugo completion zsh); compdef _hugo hugo
source <(hugo completion zsh)

To load completions for every new session, execute once:

Expand Down Expand Up @@ -51,6 +51,7 @@ hugo completion zsh [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
31 changes: 16 additions & 15 deletions docs/content/en/commands/hugo_config.md
Expand Up @@ -12,31 +12,32 @@ Print the site configuration
Print the site configuration, both default and custom settings.

```
hugo config [flags]
hugo config [command] [flags]
```

### Options

```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for config
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-h, --help help for config
```

### Options inherited from parent commands

```
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--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
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/commands/hugo_config_mounts.md
Expand Up @@ -8,7 +8,7 @@ url: /commands/hugo_config_mounts/
Print the configured file mounts

```
hugo config mounts [flags]
hugo config mounts [flags] [args]
```

### Options
Expand All @@ -24,6 +24,7 @@ hugo config mounts [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
37 changes: 21 additions & 16 deletions docs/content/en/commands/hugo_convert.md
Expand Up @@ -13,30 +13,35 @@ Convert your content (e.g. front matter) to different formats.

See convert's subcommands toJSON, toTOML and toYAML for more information.

```
hugo convert [command] [flags]
```

### Options

```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for convert
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first
-h, --help help for convert
-o, --output string filesystem path to write files to
--unsafe enable less safe operations, please backup first
```

### Options inherited from parent commands

```
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--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
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/commands/hugo_convert_toJSON.md
Expand Up @@ -13,7 +13,7 @@ toJSON converts all front matter in the content directory
to use JSON for the front matter.

```
hugo convert toJSON [flags]
hugo convert toJSON [flags] [args]
```

### Options
Expand All @@ -29,6 +29,7 @@ hugo convert toJSON [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/commands/hugo_convert_toTOML.md
Expand Up @@ -13,7 +13,7 @@ toTOML converts all front matter in the content directory
to use TOML for the front matter.

```
hugo convert toTOML [flags]
hugo convert toTOML [flags] [args]
```

### Options
Expand All @@ -29,6 +29,7 @@ hugo convert toTOML [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/commands/hugo_convert_toYAML.md
Expand Up @@ -13,7 +13,7 @@ toYAML converts all front matter in the content directory
to use YAML for the front matter.

```
hugo convert toYAML [flags]
hugo convert toYAML [flags] [args]
```

### Options
Expand All @@ -29,6 +29,7 @@ hugo convert toYAML [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
45 changes: 23 additions & 22 deletions docs/content/en/commands/hugo_deploy.md
Expand Up @@ -16,38 +16,39 @@ documentation.


```
hugo deploy [flags]
hugo deploy [flags] [args]
```

### Options

```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--confirm ask for confirmation before making changes to the target
--dryRun dry run
-e, --environment string build environment
--force force upload of all files
-h, --help help for deploy
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
--workers int number of workers to transfer files. (default 10)
-s, --source string filesystem path to read files relative from
--target string target deployment from deployments section in config file; defaults to the first one
--themesDir string filesystem path to themes directory
--confirm ask for confirmation before making changes to the target
--dryRun dry run
--force force upload of all files
-h, --help help for deploy
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
--target string target deployment from deployments section in config file; defaults to the first one
--workers int number of workers to transfer files. defaults to 10 (default 10)
```

### Options inherited from parent commands

```
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--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
Expand Down
8 changes: 3 additions & 5 deletions docs/content/en/commands/hugo_env.md
Expand Up @@ -9,13 +9,10 @@ Print Hugo version and environment info

### Synopsis

Print Hugo version and environment info. This is useful in Hugo bug reports.

If you add the -v flag, you will get a full dependency list.

Print Hugo version and environment info. This is useful in Hugo bug reports

```
hugo env [flags]
hugo env [flags] [args]
```

### Options
Expand All @@ -31,6 +28,7 @@ hugo env [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
5 changes: 5 additions & 0 deletions docs/content/en/commands/hugo_gen.md
Expand Up @@ -7,6 +7,10 @@ url: /commands/hugo_gen/

A collection of several useful generators.

```
hugo gen [command] [flags]
```

### Options

```
Expand All @@ -20,6 +24,7 @@ A collection of several useful generators.
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
3 changes: 2 additions & 1 deletion docs/content/en/commands/hugo_gen_chromastyles.md
Expand Up @@ -14,7 +14,7 @@ Generate CSS stylesheet for the Chroma code highlighter for a given style. This
See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles

```
hugo gen chromastyles [flags]
hugo gen chromastyles [flags] [args]
```

### Options
Expand All @@ -33,6 +33,7 @@ hugo gen chromastyles [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
14 changes: 7 additions & 7 deletions docs/content/en/commands/hugo_gen_doc.md
Expand Up @@ -10,15 +10,14 @@ Generate Markdown documentation for the Hugo CLI.
### Synopsis

Generate Markdown documentation for the Hugo CLI.

This command is, mostly, used to create up-to-date documentation
of Hugo's command-line interface for https://gohugo.io/.

It creates one Markdown file per command with front matter suitable
for rendering in Hugo.
This command is, mostly, used to create up-to-date documentation
of Hugo's command-line interface for https://gohugo.io/.

It creates one Markdown file per command with front matter suitable
for rendering in Hugo.

```
hugo gen doc [flags]
hugo gen doc [flags] [args]
```

### Options
Expand All @@ -35,6 +34,7 @@ hugo gen doc [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down
7 changes: 4 additions & 3 deletions docs/content/en/commands/hugo_gen_man.md
Expand Up @@ -10,11 +10,11 @@ Generate man pages for the Hugo CLI
### Synopsis

This command automatically generates up-to-date man pages of Hugo's
command-line interface. By default, it creates the man page files
in the "man" directory under the current directory.
command-line interface. By default, it creates the man page files
in the "man" directory under the current directory.

```
hugo gen man [flags]
hugo gen man [flags] [args]
```

### Options
Expand All @@ -31,6 +31,7 @@ hugo gen man [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
Expand Down

0 comments on commit 10d0fcc

Please sign in to comment.