Skip to content
Permalink
Browse files

docs: Regenerate CLI docs

  • Loading branch information...
bep committed Jul 24, 2019
1 parent 23adc0c commit 215d2ed883d5adbde1d119d33e2f2e88c8435f41
Showing with 856 additions and 271 deletions.
  1. +5 −2 docs/content/en/commands/hugo.md
  2. +14 −10 docs/content/en/commands/hugo_check.md
  3. +14 −10 docs/content/en/commands/hugo_check_ulimit.md
  4. +15 −12 docs/content/en/commands/hugo_config.md
  5. +14 −11 docs/content/en/commands/hugo_convert.md
  6. +16 −13 docs/content/en/commands/hugo_convert_toJSON.md
  7. +16 −13 docs/content/en/commands/hugo_convert_toTOML.md
  8. +16 −13 docs/content/en/commands/hugo_convert_toYAML.md
  9. +56 −0 docs/content/en/commands/hugo_deploy.md
  10. +14 −10 docs/content/en/commands/hugo_env.md
  11. +14 −10 docs/content/en/commands/hugo_gen.md
  12. +14 −10 docs/content/en/commands/hugo_gen_autocomplete.md
  13. +14 −10 docs/content/en/commands/hugo_gen_chromastyles.md
  14. +14 −10 docs/content/en/commands/hugo_gen_doc.md
  15. +14 −10 docs/content/en/commands/hugo_gen_man.md
  16. +14 −10 docs/content/en/commands/hugo_import.md
  17. +14 −10 docs/content/en/commands/hugo_import_jekyll.md
  18. +16 −12 docs/content/en/commands/hugo_list.md
  19. +46 −0 docs/content/en/commands/hugo_list_all.md
  20. +14 −11 docs/content/en/commands/hugo_list_drafts.md
  21. +15 −13 docs/content/en/commands/hugo_list_expired.md
  22. +15 −13 docs/content/en/commands/hugo_list_future.md
  23. +83 −0 docs/content/en/commands/hugo_mod.md
  24. +52 −0 docs/content/en/commands/hugo_mod_clean.md
  25. +71 −0 docs/content/en/commands/hugo_mod_get.md
  26. +48 −0 docs/content/en/commands/hugo_mod_graph.md
  27. +53 −0 docs/content/en/commands/hugo_mod_init.md
  28. +46 −0 docs/content/en/commands/hugo_mod_tidy.md
  29. +49 −0 docs/content/en/commands/hugo_mod_vendor.md
  30. +14 −13 docs/content/en/commands/hugo_new.md
  31. +14 −11 docs/content/en/commands/hugo_new_site.md
  32. +14 −11 docs/content/en/commands/hugo_new_theme.md
  33. +14 −13 docs/content/en/commands/hugo_server.md
  34. +14 −10 docs/content/en/commands/hugo_version.md
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo"
slug: hugo
url: /commands/hugo/
@@ -43,6 +43,7 @@ hugo [flags]
-h, --help help for hugo
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
--ignoreVendor ignores any _vendor directory
-l, --layoutDir string filesystem path to layout directory
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
@@ -68,12 +69,14 @@ hugo [flags]
* [hugo check](/commands/hugo_check/) - Contains some verification checks
* [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.
* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
* [hugo import](/commands/hugo_import/) - Import your site from others.
* [hugo list](/commands/hugo_list/) - Listing out various types of content
* [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

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@@ -21,19 +21,23 @@ Contains some verification checks
### 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
--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
--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
--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 check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@@ -26,18 +26,22 @@ hugo check ulimit [flags]
### 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
--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
--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
--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 check](/commands/hugo_check/) - Contains some verification checks

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@@ -19,25 +19,28 @@ hugo config [flags]
### Options

```
-h, --help help for config
-s, --source string filesystem path to read files relative from
-h, --help help for config
```

### 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
--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
--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
--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

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@@ -19,21 +19,24 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
```
-h, --help help for convert
-o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
```

### 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
--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
--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
--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
@@ -43,4 +46,4 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@@ -26,21 +26,24 @@ hugo convert toJSON [flags]
### 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
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
--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
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-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
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@@ -26,21 +26,24 @@ hugo convert toTOML [flags]
### 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
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
--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
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-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
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -1,5 +1,5 @@
---
date: 2019-03-26
date: 2019-07-24
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@@ -26,21 +26,24 @@ hugo convert toYAML [flags]
### 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
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
--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
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-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
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 26-Mar-2019
###### Auto generated by spf13/cobra on 24-Jul-2019
@@ -0,0 +1,56 @@
---
date: 2019-07-24
title: "hugo deploy"
slug: hugo_deploy
url: /commands/hugo_deploy/
---
## hugo deploy

Deploy your site to a Cloud provider.

### Synopsis

Deploy your site to a Cloud provider.

See https://gohugo.io/hosting-and-deployment/hugo-deploy/ for detailed
documentation.


```
hugo deploy [flags]
```

### Options

```
--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 via the cloudFrontDistributionID 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
```

### 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
--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

###### Auto generated by spf13/cobra on 24-Jul-2019

0 comments on commit 215d2ed

Please sign in to comment.
You can’t perform that action at this time.