shithub: hugo

Download patch

ref: d460159a5f14eadfab4a55ea3444cc326d9a489f
parent: 8b49c3a17547cf073dd555d4a0b6b68268c85d76
author: Bjørn Erik Pedersen <[email protected]>
date: Tue May 23 17:00:36 EDT 2017

docs: Regenerate commands docs

Closes #3400

--- a/docs/content/commands/hugo.md
+++ b/docs/content/commands/hugo.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo"
 slug: hugo
 url: /commands/hugo/
@@ -19,7 +19,7 @@
 Complete documentation is available at http://gohugo.io/.
 
 ```
-hugo
+hugo [flags]
 ```
 
 ### Options
@@ -41,6 +41,7 @@
       --disableSitemap             do not build Sitemap file
       --enableGitInfo              add Git revision, date and author info to the pages
       --forceSyncStatic            copy all files when static is changed.
+  -h, --help                       help for hugo
       --i18n-warnings              print missing translations
       --ignoreCache                ignores the cache directory
   -l, --layoutDir string           filesystem path to layout directory
@@ -64,7 +65,6 @@
 
 ### SEE ALSO
 * [hugo benchmark](/commands/hugo_benchmark/)	 - Benchmark Hugo by building a site a number of times.
-* [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 env](/commands/hugo_env/)	 - Print Hugo version and environment info
@@ -76,4 +76,4 @@
 * [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 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_benchmark.md
+++ b/docs/content/commands/hugo_benchmark.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo benchmark"
 slug: hugo_benchmark
 url: /commands/hugo_benchmark/
@@ -15,7 +15,7 @@
 creating a benchmark.
 
 ```
-hugo benchmark
+hugo benchmark [flags]
 ```
 
 ### Options
@@ -38,6 +38,7 @@
       --disableSitemap             do not build Sitemap file
       --enableGitInfo              add Git revision, date and author info to the pages
       --forceSyncStatic            copy all files when static is changed.
+  -h, --help                       help for benchmark
       --i18n-warnings              print missing translations
       --ignoreCache                ignores the cache directory
   -l, --layoutDir string           filesystem path to layout directory
@@ -68,4 +69,4 @@
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_config.md
+++ b/docs/content/commands/hugo_config.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo config"
 slug: hugo_config
 url: /commands/hugo_config/
@@ -14,9 +14,15 @@
 Print the site configuration, both default and custom settings.
 
 ```
-hugo config
+hugo config [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for config
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -31,4 +37,4 @@
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_convert.md
+++ b/docs/content/commands/hugo_convert.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo convert"
 slug: hugo_convert
 url: /commands/hugo_convert/
@@ -18,6 +18,7 @@
 ### Options
 
 ```
+  -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
@@ -40,4 +41,4 @@
 * [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-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_convert_toJSON.md
+++ b/docs/content/commands/hugo_convert_toJSON.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo convert toJSON"
 slug: hugo_convert_toJSON
 url: /commands/hugo_convert_tojson/
@@ -15,9 +15,15 @@
 to use JSON for the front matter.
 
 ```
-hugo convert toJSON
+hugo convert toJSON [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for toJSON
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -35,4 +41,4 @@
 ### SEE ALSO
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_convert_toTOML.md
+++ b/docs/content/commands/hugo_convert_toTOML.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo convert toTOML"
 slug: hugo_convert_toTOML
 url: /commands/hugo_convert_totoml/
@@ -15,9 +15,15 @@
 to use TOML for the front matter.
 
 ```
-hugo convert toTOML
+hugo convert toTOML [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for toTOML
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -35,4 +41,4 @@
 ### SEE ALSO
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_convert_toYAML.md
+++ b/docs/content/commands/hugo_convert_toYAML.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo convert toYAML"
 slug: hugo_convert_toYAML
 url: /commands/hugo_convert_toyaml/
@@ -15,9 +15,15 @@
 to use YAML for the front matter.
 
 ```
-hugo convert toYAML
+hugo convert toYAML [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for toYAML
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -35,4 +41,4 @@
 ### SEE ALSO
 * [hugo convert](/commands/hugo_convert/)	 - Convert your content to different formats
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_env.md
+++ b/docs/content/commands/hugo_env.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo env"
 slug: hugo_env
 url: /commands/hugo_env/
@@ -14,9 +14,15 @@
 Print Hugo version and environment info. This is useful in Hugo bug reports.
 
 ```
-hugo env
+hugo env [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for env
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -31,4 +37,4 @@
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_gen.md
+++ b/docs/content/commands/hugo_gen.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo gen"
 slug: hugo_gen
 url: /commands/hugo_gen/
@@ -13,6 +13,12 @@
 
 A collection of several useful generators.
 
+### Options
+
+```
+  -h, --help   help for gen
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -30,4 +36,4 @@
 * [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 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_gen_autocomplete.md
+++ b/docs/content/commands/hugo_gen_autocomplete.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo gen autocomplete"
 slug: hugo_gen_autocomplete
 url: /commands/hugo_gen_autocomplete/
@@ -30,7 +30,7 @@
 	$ . /etc/bash_completion
 
 ```
-hugo gen autocomplete
+hugo gen autocomplete [flags]
 ```
 
 ### Options
@@ -37,6 +37,7 @@
 
 ```
       --completionfile string   autocompletion file (default "/etc/bash_completion.d/hugo.sh")
+  -h, --help                    help for autocomplete
       --type string             autocompletion type (currently only bash supported) (default "bash")
 ```
 
@@ -54,4 +55,4 @@
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_gen_doc.md
+++ b/docs/content/commands/hugo_gen_doc.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo gen doc"
 slug: hugo_gen_doc
 url: /commands/hugo_gen_doc/
@@ -20,7 +20,7 @@
 for rendering in Hugo.
 
 ```
-hugo gen doc
+hugo gen doc [flags]
 ```
 
 ### Options
@@ -44,4 +44,4 @@
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_gen_man.md
+++ b/docs/content/commands/hugo_gen_man.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo gen man"
 slug: hugo_gen_man
 url: /commands/hugo_gen_man/
@@ -16,7 +16,7 @@
 in the "man" directory under the current directory.
 
 ```
-hugo gen man
+hugo gen man [flags]
 ```
 
 ### Options
@@ -23,6 +23,7 @@
 
 ```
       --dir string   the directory to write the man pages. (default "man/")
+  -h, --help         help for man
 ```
 
 ### Options inherited from parent commands
@@ -39,4 +40,4 @@
 ### SEE ALSO
 * [hugo gen](/commands/hugo_gen/)	 - A collection of several useful generators.
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_import.md
+++ b/docs/content/commands/hugo_import.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo import"
 slug: hugo_import
 url: /commands/hugo_import/
@@ -15,6 +15,12 @@
 
 Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
 
+### Options
+
+```
+  -h, --help   help for import
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -30,4 +36,4 @@
 * [hugo](/commands/hugo/)	 - hugo builds your site
 * [hugo import jekyll](/commands/hugo_import_jekyll/)	 - hugo import from Jekyll
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_import_jekyll.md
+++ b/docs/content/commands/hugo_import_jekyll.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo import jekyll"
 slug: hugo_import_jekyll
 url: /commands/hugo_import_jekyll/
@@ -16,7 +16,7 @@
 Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`.
 
 ```
-hugo import jekyll
+hugo import jekyll [flags]
 ```
 
 ### Options
@@ -23,6 +23,7 @@
 
 ```
       --force   allow import into non-empty target directory
+  -h, --help    help for jekyll
 ```
 
 ### Options inherited from parent commands
@@ -39,4 +40,4 @@
 ### SEE ALSO
 * [hugo import](/commands/hugo_import/)	 - Import your site from others.
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_list.md
+++ b/docs/content/commands/hugo_list.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo list"
 slug: hugo_list
 url: /commands/hugo_list/
@@ -18,6 +18,7 @@
 ### Options
 
 ```
+  -h, --help            help for list
   -s, --source string   filesystem path to read files relative from
 ```
 
@@ -38,4 +39,4 @@
 * [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 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_list_drafts.md
+++ b/docs/content/commands/hugo_list_drafts.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo list drafts"
 slug: hugo_list_drafts
 url: /commands/hugo_list_drafts/
@@ -14,9 +14,15 @@
 List all of the drafts in your content directory.
 
 ```
-hugo list drafts
+hugo list drafts [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for drafts
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -32,4 +38,4 @@
 ### SEE ALSO
 * [hugo list](/commands/hugo_list/)	 - Listing out various types of content
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_list_expired.md
+++ b/docs/content/commands/hugo_list_expired.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo list expired"
 slug: hugo_list_expired
 url: /commands/hugo_list_expired/
@@ -15,9 +15,15 @@
 expired.
 
 ```
-hugo list expired
+hugo list expired [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for expired
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -33,4 +39,4 @@
 ### SEE ALSO
 * [hugo list](/commands/hugo_list/)	 - Listing out various types of content
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_list_future.md
+++ b/docs/content/commands/hugo_list_future.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo list future"
 slug: hugo_list_future
 url: /commands/hugo_list_future/
@@ -15,9 +15,15 @@
 posted in the future.
 
 ```
-hugo list future
+hugo list future [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for future
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -33,4 +39,4 @@
 ### SEE ALSO
 * [hugo list](/commands/hugo_list/)	 - Listing out various types of content
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_new.md
+++ b/docs/content/commands/hugo_new.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo new"
 slug: hugo_new
 url: /commands/hugo_new/
@@ -19,7 +19,7 @@
 If archetypes are provided in your theme or site, they will be used.
 
 ```
-hugo new [path]
+hugo new [path] [flags]
 ```
 
 ### Options
@@ -27,6 +27,7 @@
 ```
       --editor string   edit new content with this editor, if provided
   -f, --format string   frontmatter format (default "toml")
+  -h, --help            help for new
   -k, --kind string     content type to create
   -s, --source string   filesystem path to read files relative from
 ```
@@ -47,4 +48,4 @@
 * [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 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_new_site.md
+++ b/docs/content/commands/hugo_new_site.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo new site"
 slug: hugo_new_site
 url: /commands/hugo_new_site/
@@ -16,7 +16,7 @@
 Use `hugo new [contentPath]` to create new content.
 
 ```
-hugo new site [path]
+hugo new site [path] [flags]
 ```
 
 ### Options
@@ -24,6 +24,7 @@
 ```
       --force           init inside non-empty directory
   -f, --format string   config & frontmatter format (default "toml")
+  -h, --help            help for site
 ```
 
 ### Options inherited from parent commands
@@ -41,4 +42,4 @@
 ### SEE ALSO
 * [hugo new](/commands/hugo_new/)	 - Create new content for your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_new_theme.md
+++ b/docs/content/commands/hugo_new_theme.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo new theme"
 slug: hugo_new_theme
 url: /commands/hugo_new_theme/
@@ -17,9 +17,15 @@
 as you see fit.
 
 ```
-hugo new theme [name]
+hugo new theme [name] [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for theme
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -35,4 +41,4 @@
 ### SEE ALSO
 * [hugo new](/commands/hugo_new/)	 - Create new content for your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_server.md
+++ b/docs/content/commands/hugo_server.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo server"
 slug: hugo_server
 url: /commands/hugo_server/
@@ -25,7 +25,7 @@
 of a second, you will be able to save and see your changes nearly instantly.
 
 ```
-hugo server
+hugo server [flags]
 ```
 
 ### Options
@@ -49,6 +49,7 @@
       --disableSitemap             do not build Sitemap file
       --enableGitInfo              add Git revision, date and author info to the pages
       --forceSyncStatic            copy all files when static is changed.
+  -h, --help                       help for server
       --i18n-warnings              print missing translations
       --ignoreCache                ignores the cache directory
   -l, --layoutDir string           filesystem path to layout directory
@@ -82,4 +83,4 @@
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_undraft.md
+++ b/docs/content/commands/hugo_undraft.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo undraft"
 slug: hugo_undraft
 url: /commands/hugo_undraft/
@@ -16,9 +16,15 @@
 If the content's draft status is 'False', nothing is done.
 
 ```
-hugo undraft path/to/content
+hugo undraft path/to/content [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for undraft
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -33,4 +39,4 @@
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017
--- a/docs/content/commands/hugo_version.md
+++ b/docs/content/commands/hugo_version.md
@@ -1,5 +1,5 @@
 ---
-date: 2017-04-26T22:40:07+02:00
+date: 2017-05-23T20:59:46+03:00
 title: "hugo version"
 slug: hugo_version
 url: /commands/hugo_version/
@@ -14,9 +14,15 @@
 All software has versions. This is Hugo's.
 
 ```
-hugo version
+hugo version [flags]
 ```
 
+### Options
+
+```
+  -h, --help   help for version
+```
+
 ### Options inherited from parent commands
 
 ```
@@ -31,4 +37,4 @@
 ### SEE ALSO
 * [hugo](/commands/hugo/)	 - hugo builds your site
 
-###### Auto generated by spf13/cobra on 26-Apr-2017
+###### Auto generated by spf13/cobra on 23-May-2017