ref: 1e27d0589118a114e49c032e4bd68b4798e44a5b
parent: d418c2c2eacdc1dc6fffe839e0a90600867878ca
author: Bjørn Erik Pedersen <[email protected]>
date: Thu Jan 25 05:24:59 EST 2018
docs: Re-generate CLI docs
--- a/docs/content/commands/hugo.md
+++ b/docs/content/commands/hugo.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo"
slug: hugo
url: /commands/hugo/
@@ -10,7 +10,6 @@
### Synopsis
-
hugo is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator
@@ -36,10 +35,7 @@
-c, --contentDir string filesystem path to content directory
--debug debug output
-d, --destination string filesystem path to write files to
- --disable404 do not render 404 page
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
- --disableRSS do not build RSS files
- --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.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
@@ -68,6 +64,7 @@
```
### 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
@@ -81,4 +78,4 @@
* [hugo undraft](/commands/hugo_undraft/) - Undraft resets the content's draft status
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_benchmark.md
+++ b/docs/content/commands/hugo_benchmark.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
@@ -10,7 +10,6 @@
### Synopsis
-
Hugo can build a site many times over and analyze the running process
creating a benchmark.
@@ -32,10 +31,7 @@
-n, --count int number of times to build the site (default 13)
--cpuprofile string path/filename for the CPU profile file
-d, --destination string filesystem path to write files to
- --disable404 do not render 404 page
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
- --disableRSS do not build RSS files
- --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.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
@@ -71,6 +67,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_check.md
+++ b/docs/content/commands/hugo_check.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@@ -10,7 +10,6 @@
### Synopsis
-
Contains some verification checks
### Options
@@ -32,7 +31,8 @@
```
### 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 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_check_ulimit.md
+++ b/docs/content/commands/hugo_check_ulimit.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@@ -10,7 +10,6 @@
### Synopsis
-
Hugo will inspect the current ulimit settings on the system.
This is primarily to ensure that Hugo can watch enough files on some OSs
@@ -37,6 +36,7 @@
```
### SEE ALSO
+
* [hugo check](/commands/hugo_check/) - Contains some verification checks
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_config.md
+++ b/docs/content/commands/hugo_config.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@@ -10,7 +10,6 @@
### Synopsis
-
Print the site configuration, both default and custom settings.
```
@@ -36,6 +35,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_convert.md
+++ b/docs/content/commands/hugo_convert.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@@ -10,7 +10,6 @@
### Synopsis
-
Convert your content (e.g. front matter) to different formats.
See convert's subcommands toJSON, toTOML and toYAML for more information.
@@ -37,9 +36,10 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON
* [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 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_convert_toJSON.md
+++ b/docs/content/commands/hugo_convert_toJSON.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@@ -10,7 +10,6 @@
### Synopsis
-
toJSON converts all front matter in the content directory
to use JSON for the front matter.
@@ -40,6 +39,7 @@
```
### SEE ALSO
+
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_convert_toTOML.md
+++ b/docs/content/commands/hugo_convert_toTOML.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@@ -10,7 +10,6 @@
### Synopsis
-
toTOML converts all front matter in the content directory
to use TOML for the front matter.
@@ -40,6 +39,7 @@
```
### SEE ALSO
+
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_convert_toYAML.md
+++ b/docs/content/commands/hugo_convert_toYAML.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@@ -10,7 +10,6 @@
### Synopsis
-
toYAML converts all front matter in the content directory
to use YAML for the front matter.
@@ -40,6 +39,7 @@
```
### SEE ALSO
+
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_env.md
+++ b/docs/content/commands/hugo_env.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
@@ -10,7 +10,6 @@
### Synopsis
-
Print Hugo version and environment info. This is useful in Hugo bug reports.
```
@@ -36,6 +35,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_gen.md
+++ b/docs/content/commands/hugo_gen.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
@@ -10,7 +10,6 @@
### Synopsis
-
A collection of several useful generators.
### Options
@@ -32,6 +31,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo
* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter
@@ -38,4 +38,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 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_gen_autocomplete.md
+++ b/docs/content/commands/hugo_gen_autocomplete.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
@@ -10,7 +10,6 @@
### Synopsis
-
Generates a shell autocompletion script for Hugo.
NOTE: The current version supports Bash only.
@@ -54,6 +53,7 @@
```
### SEE ALSO
+
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_gen_chromastyles.md
+++ b/docs/content/commands/hugo_gen_chromastyles.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
@@ -10,7 +10,6 @@
### Synopsis
-
Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config.
See https://help.farbox.com/pygments.html for preview of available styles
@@ -41,6 +40,7 @@
```
### SEE ALSO
+
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_gen_doc.md
+++ b/docs/content/commands/hugo_gen_doc.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
@@ -10,7 +10,6 @@
### Synopsis
-
Generate Markdown documentation for the Hugo CLI.
This command is, mostly, used to create up-to-date documentation
@@ -43,6 +42,7 @@
```
### SEE ALSO
+
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_gen_man.md
+++ b/docs/content/commands/hugo_gen_man.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
@@ -10,7 +10,6 @@
### 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.
@@ -39,6 +38,7 @@
```
### SEE ALSO
+
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_import.md
+++ b/docs/content/commands/hugo_import.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
@@ -10,7 +10,6 @@
### Synopsis
-
Import your site from other web site generators like Jekyll.
Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
@@ -34,7 +33,8 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_import_jekyll.md
+++ b/docs/content/commands/hugo_import_jekyll.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
@@ -10,7 +10,6 @@
### Synopsis
-
hugo import from Jekyll.
Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`.
@@ -39,6 +38,7 @@
```
### SEE ALSO
+
* [hugo import](/commands/hugo_import/) - Import your site from others.
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_list.md
+++ b/docs/content/commands/hugo_list.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
@@ -10,7 +10,6 @@
### Synopsis
-
Listing out various types of content.
List requires a subcommand, e.g. `hugo list drafts`.
@@ -35,9 +34,10 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo list drafts](/commands/hugo_list_drafts/) - List all 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 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_list_drafts.md
+++ b/docs/content/commands/hugo_list_drafts.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
@@ -10,7 +10,6 @@
### Synopsis
-
List all of the drafts in your content directory.
```
@@ -37,6 +36,7 @@
```
### SEE ALSO
+
* [hugo list](/commands/hugo_list/) - Listing out various types of content
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_list_expired.md
+++ b/docs/content/commands/hugo_list_expired.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
@@ -10,7 +10,6 @@
### Synopsis
-
List all of the posts in your content directory which has already
expired.
@@ -38,6 +37,7 @@
```
### SEE ALSO
+
* [hugo list](/commands/hugo_list/) - Listing out various types of content
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_list_future.md
+++ b/docs/content/commands/hugo_list_future.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
@@ -10,7 +10,6 @@
### Synopsis
-
List all of the posts in your content directory which will be
posted in the future.
@@ -38,6 +37,7 @@
```
### SEE ALSO
+
* [hugo list](/commands/hugo_list/) - Listing out various types of content
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_new.md
+++ b/docs/content/commands/hugo_new.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo new"
slug: hugo_new
url: /commands/hugo_new/
@@ -10,7 +10,6 @@
### Synopsis
-
Create a new content file and automatically set the date and title.
It will guess which kind of file to create based on the path provided.
@@ -44,8 +43,9 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
* [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 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_new_site.md
+++ b/docs/content/commands/hugo_new_site.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo new site"
slug: hugo_new_site
url: /commands/hugo_new_site/
@@ -10,7 +10,6 @@
### Synopsis
-
Create a new site in the provided directory.
The new site will have the correct structure, but no content or theme yet.
Use `hugo new [contentPath]` to create new content.
@@ -41,6 +40,7 @@
```
### SEE ALSO
+
* [hugo new](/commands/hugo_new/) - Create new content for your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_new_theme.md
+++ b/docs/content/commands/hugo_new_theme.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo new theme"
slug: hugo_new_theme
url: /commands/hugo_new_theme/
@@ -10,7 +10,6 @@
### Synopsis
-
Create a new theme (skeleton) called [name] in the current directory.
New theme is a skeleton. Please add content to the touched files. Add your
name to the copyright line in the license and adjust the theme.toml file
@@ -40,6 +39,7 @@
```
### SEE ALSO
+
* [hugo new](/commands/hugo_new/) - Create new content for your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_server.md
+++ b/docs/content/commands/hugo_server.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
@@ -10,7 +10,6 @@
### Synopsis
-
Hugo provides its own webserver which builds and serves the site.
While hugo server is high performance, it is a webserver with limited options.
Many run it in production, but the standard behavior is for people to use it
@@ -42,12 +41,9 @@
--cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
- --disable404 do not render 404 page
--disableFastRender enables full re-renders on changes
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild
- --disableRSS do not build RSS files
- --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.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
@@ -89,6 +85,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_undraft.md
+++ b/docs/content/commands/hugo_undraft.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo undraft"
slug: hugo_undraft
url: /commands/hugo_undraft/
@@ -10,7 +10,6 @@
### Synopsis
-
Undraft resets the content's draft status
and updates the date to the current date and time.
If the content's draft status is 'False', nothing is done.
@@ -38,6 +37,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018
--- a/docs/content/commands/hugo_version.md
+++ b/docs/content/commands/hugo_version.md
@@ -1,5 +1,5 @@
---
-date: 2017-12-28T18:49:29+01:00
+date: 2018-01-25T10:24:52+01:00
title: "hugo version"
slug: hugo_version
url: /commands/hugo_version/
@@ -10,7 +10,6 @@
### Synopsis
-
All software has versions. This is Hugo's.
```
@@ -36,6 +35,7 @@
```
### SEE ALSO
+
* [hugo](/commands/hugo/) - hugo builds your site
-###### Auto generated by spf13/cobra on 28-Dec-2017
+###### Auto generated by spf13/cobra on 25-Jan-2018