docs: Regenerate commands doc

This commit is contained in:
Bjørn Erik Pedersen 2016-10-05 10:23:45 +02:00
parent 2a4ed1c492
commit b3a113b73a
26 changed files with 114 additions and 61 deletions

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo"
slug: hugo
url: /commands/hugo/
@ -39,6 +39,7 @@ hugo
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--i18n-warnings Print missing translations
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--log Enable Logging
@ -61,6 +62,7 @@ hugo
* [hugo check](/commands/hugo_check/) - Check content in the source directory
* [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [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
@ -69,4 +71,4 @@ hugo
* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False'
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
@ -28,7 +28,6 @@ hugo benchmark
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir Remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
-n, --count int number of times to build the site (default 13)
--cpuprofile string path/filename for the CPU profile file
@ -37,6 +36,7 @@ hugo benchmark
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--i18n-warnings Print missing translations
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--memprofile string path/filename for the memory profile file
@ -53,6 +53,7 @@ hugo benchmark
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -62,4 +63,4 @@ hugo benchmark
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@ -28,13 +28,13 @@ hugo check
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir Remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disable404 Do not render 404 page
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--i18n-warnings Print missing translations
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--noTimes Don't sync modification time of files
@ -49,6 +49,7 @@ hugo check
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -59,4 +60,4 @@ hugo check
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@ -21,6 +21,7 @@ hugo check ulimit
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -30,4 +31,4 @@ hugo check ulimit
### SEE ALSO
* [hugo check](/commands/hugo_check/) - Check content in the source directory
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@ -17,15 +17,10 @@ Print the site configuration, both default and custom settings.
hugo config
```
### Options
```
--config string config file (default is path/config.yaml|json|toml)
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -35,4 +30,4 @@ hugo config
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@ -26,6 +26,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -38,4 +39,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 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@ -21,6 +21,7 @@ hugo convert toJSON
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
@ -33,4 +34,4 @@ hugo convert toJSON
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@ -21,6 +21,7 @@ hugo convert toTOML
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
@ -33,4 +34,4 @@ hugo convert toTOML
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@ -21,6 +21,7 @@ hugo convert toYAML
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
@ -33,4 +34,4 @@ hugo convert toYAML
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -0,0 +1,33 @@
---
date: 2016-10-05T10:21:48+02:00
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
---
## hugo env
Print Hugo version and environment info
### Synopsis
Print Hugo version and environment info. This is useful in Hugo bug reports.
```
hugo env
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
@ -16,6 +16,7 @@ A collection of several useful generators.
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -28,4 +29,4 @@ A collection of several useful generators.
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
@ -43,6 +43,7 @@ hugo gen autocomplete
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -52,4 +53,4 @@ hugo gen autocomplete
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
@ -32,6 +32,7 @@ hugo gen doc
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -41,4 +42,4 @@ hugo gen doc
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
@ -28,6 +28,7 @@ hugo gen man
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -37,4 +38,4 @@ hugo gen man
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
@ -18,6 +18,7 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -28,4 +29,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
@ -28,6 +28,7 @@ hugo import jekyll
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -37,4 +38,4 @@ hugo import jekyll
### SEE ALSO
* [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
@ -24,6 +24,7 @@ List requires a subcommand, e.g. `hugo list drafts`.
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -36,4 +37,4 @@ List requires a subcommand, e.g. `hugo list drafts`.
* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
@ -20,6 +20,7 @@ hugo list drafts
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-s, --source string filesystem path to read files relative from
@ -30,4 +31,4 @@ hugo list drafts
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
@ -21,6 +21,7 @@ hugo list expired
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-s, --source string filesystem path to read files relative from
@ -31,4 +32,4 @@ hugo list expired
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
@ -21,6 +21,7 @@ hugo list future
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-s, --source string filesystem path to read files relative from
@ -31,4 +32,4 @@ hugo list future
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo new"
slug: hugo_new
url: /commands/hugo_new/
@ -34,6 +34,7 @@ hugo new [path]
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -45,4 +46,4 @@ hugo new [path]
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo new site"
slug: hugo_new_site
url: /commands/hugo_new_site/
@ -29,6 +29,7 @@ hugo new site [path]
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-s, --source string filesystem path to read files relative from
@ -39,4 +40,4 @@ hugo new site [path]
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo new theme"
slug: hugo_new_theme
url: /commands/hugo_new_theme/
@ -23,6 +23,7 @@ hugo new theme [name]
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-s, --source string filesystem path to read files relative from
@ -33,4 +34,4 @@ hugo new theme [name]
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
@ -40,7 +40,6 @@ hugo server
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir Remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disable404 Do not render 404 page
@ -48,9 +47,10 @@ hugo server
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--i18n-warnings Print missing translations
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--meminterval int interval to poll memory usage (requires --memstats) (default 100)
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
--memstats string log memory usage to this file
--noTimes Don't sync modification time of files
--pluralizeListTitles Pluralize titles in lists using inflect (default true)
@ -67,6 +67,7 @@ hugo server
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -76,4 +77,4 @@ hugo server
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo undraft"
slug: hugo_undraft
url: /commands/hugo_undraft/
@ -22,6 +22,7 @@ hugo undraft path/to/content
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -31,4 +32,4 @@ hugo undraft path/to/content
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016

View file

@ -1,5 +1,5 @@
---
date: 2016-06-22T14:03:03+02:00
date: 2016-10-05T10:21:48+02:00
title: "hugo version"
slug: hugo_version
url: /commands/hugo_version/
@ -20,6 +20,7 @@ hugo version
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-v, --verbose verbose output
@ -29,4 +30,4 @@ hugo version
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2016
###### Auto generated by spf13/cobra on 5-Oct-2016