phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-05 08:42:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Regenerate the commands docs

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2016-04-09 23:01:55 +02:00
parent b7efbdc12f
commit ff7eec2f48
24 changed files with 273 additions and 289 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
docs/content/commands/hugo.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo" title: "hugo"
slug: hugo slug: hugo
url: /commands/hugo/ url: /commands/hugo/
@ -25,30 +25,33 @@ hugo
### Options ### Options
``` ```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--config="": config file (default is path/config.yaml|json|toml) --cleanDestinationDir Remove files from destination not found in static directories
-d, --destination="": filesystem path to write files to --config string config file (default is path/config.yaml|json|toml)
--disableRSS[=false]: Do not build RSS files -c, --contentDir string filesystem path to content directory
--disableSitemap[=false]: Do not build Sitemap file -d, --destination string filesystem path to write files to
--disableRobotsTXT[=false]: Do not build robots TXT file --disableRSS Do not build RSS files
--editor="": edit new content with this editor, if provided --disableSitemap Do not build Sitemap file
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it --forceSyncStatic Copy all files when static is changed.
--log[=false]: Enable Logging --ignoreCache Ignores the cache directory for reading but still writes to it
--logFile="": Log File path (if set, logging enabled automatically) -l, --layoutDir string filesystem path to layout directory
--noTimes[=false]: Don't sync modification time of files --log Enable Logging
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect --logFile string Log File path (if set, logging enabled automatically)
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --noTimes Don't sync modification time of files
-s, --source="": filesystem path to read files relative from --pluralizeListTitles Pluralize titles in lists using inflect (default true)
--stepAnalysis[=false]: display memory and timing of different steps of the program --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-t, --theme="": theme to use (located in /themes/THEMENAME/) --renderToMemory render to memory (only useful for benchmark testing)
--uglyURLs[=false]: if true, use /filename.html instead of /filename/ -s, --source string filesystem path to read files relative from
-v, --verbose[=false]: verbose output --stepAnalysis display memory and timing of different steps of the program
--verboseLog[=false]: verbose logging -t, --theme string theme to use (located in /themes/THEMENAME/)
-w, --watch[=false]: watch filesystem for changes and recreate as needed --uglyURLs if true, use /filename.html instead of /filename/
-v, --verbose verbose output
--verboseLog verbose logging
-w, --watch watch filesystem for changes and recreate as needed
``` ```
### SEE ALSO ### SEE ALSO
@ -64,4 +67,4 @@ hugo
* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False' * [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 * [hugo version](/commands/hugo_version/) - Print the version number of Hugo
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

57
docs/content/commands/hugo_benchmark.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo benchmark" title: "hugo benchmark"
slug: hugo_benchmark slug: hugo_benchmark
url: /commands/hugo_benchmark/ url: /commands/hugo_benchmark/
@ -21,38 +21,43 @@ hugo benchmark
### Options ### Options
``` ```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--config="": config file (default is path/config.yaml|json|toml) --cleanDestinationDir Remove files from destination not found in static directories
-n, --count=13: number of times to build the site --config string config file (default is path/config.yaml|json|toml)
--cpuprofile="": path/filename for the CPU profile file -c, --contentDir string filesystem path to content directory
-d, --destination="": filesystem path to write files to -n, --count int number of times to build the site (default 13)
--disableRSS[=false]: Do not build RSS files --cpuprofile string path/filename for the CPU profile file
--disableSitemap[=false]: Do not build Sitemap file -d, --destination string filesystem path to write files to
--editor="": edit new content with this editor, if provided --disableRSS Do not build RSS files
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it --disableSitemap Do not build Sitemap file
--memprofile="": path/filename for the memory profile file --forceSyncStatic Copy all files when static is changed.
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect --ignoreCache Ignores the cache directory for reading but still writes to it
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") -l, --layoutDir string filesystem path to layout directory
-s, --source="": filesystem path to read files relative from --memprofile string path/filename for the memory profile file
--stepAnalysis[=false]: display memory and timing of different steps of the program --noTimes Don't sync modification time of files
-t, --theme="": theme to use (located in /themes/THEMENAME/) --pluralizeListTitles Pluralize titles in lists using inflect (default true)
--uglyURLs[=false]: if true, use /filename.html instead of /filename/ --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program
-t, --theme string theme to use (located in /themes/THEMENAME/)
--uglyURLs if true, use /filename.html instead of /filename/
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

51
docs/content/commands/hugo_check.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo check" title: "hugo check"
slug: hugo_check slug: hugo_check
url: /commands/hugo_check/ url: /commands/hugo_check/
@ -21,35 +21,40 @@ hugo check
### Options ### Options
``` ```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--config="": config file (default is path/config.yaml|json|toml) --cleanDestinationDir Remove files from destination not found in static directories
-d, --destination="": filesystem path to write files to --config string config file (default is path/config.yaml|json|toml)
--disableRSS[=false]: Do not build RSS files -c, --contentDir string filesystem path to content directory
--disableSitemap[=false]: Do not build Sitemap file -d, --destination string filesystem path to write files to
--editor="": edit new content with this editor, if provided --disableRSS Do not build RSS files
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it --disableSitemap Do not build Sitemap file
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect --forceSyncStatic Copy all files when static is changed.
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --ignoreCache Ignores the cache directory for reading but still writes to it
-s, --source="": filesystem path to read files relative from -l, --layoutDir string filesystem path to layout directory
--stepAnalysis[=false]: display memory and timing of different steps of the program --noTimes Don't sync modification time of files
-t, --theme="": theme to use (located in /themes/THEMENAME/) --pluralizeListTitles Pluralize titles in lists using inflect (default true)
--uglyURLs[=false]: if true, use /filename.html instead of /filename/ --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program
-t, --theme string theme to use (located in /themes/THEMENAME/)
--uglyURLs if true, use /filename.html instead of /filename/
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

31
docs/content/commands/hugo_check_ulimit.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-11-25T23:10:39+01:00 date: 2016-04-09T23:00:06+02:00
title: "hugo check ulimit" title: "hugo check ulimit"
slug: hugo_check_ulimit slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/ url: /commands/hugo_check_ulimit/
@ -12,7 +12,7 @@ Check system ulimit settings
Hugo will inspect the current ulimit settings on the system. Hugo will inspect the current ulimit settings on the system.
This is primarily to ensure that Hugo can watch enough files on some OSs This is primarily to ensure that Hugo can watch enough files on some OSs
``` ```
hugo check ulimit hugo check ulimit
@ -21,30 +21,13 @@ hugo check ulimit
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ --log Enable Logging
-D, --buildDrafts[=false]: include content marked as draft --logFile string Log File path (if set, logging enabled automatically)
-F, --buildFuture[=false]: include content with publishdate in the future -v, --verbose verbose output
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --verboseLog verbose logging
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL
--config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files
--disableSitemap[=false]: Do not build Sitemap file
--editor="": edit new content with this editor, if provided
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it
--log[=false]: Enable Logging
--logFile="": Log File path (if set, logging enabled automatically)
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-s, --source="": filesystem path to read files relative from
--stepAnalysis[=false]: display memory and timing of different steps of the program
-t, --theme="": theme to use (located in /themes/THEMENAME/)
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo check](/commands/hugo_check/) - Check content in the source directory * [hugo check](/commands/hugo_check/) - Check content in the source directory
###### Auto generated by spf13/cobra on 25-Nov-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

30
docs/content/commands/hugo_config.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo config" title: "hugo config"
slug: hugo_config slug: hugo_config
url: /commands/hugo_config/ url: /commands/hugo_config/
@ -20,35 +20,19 @@ hugo config
### Options ### Options
``` ```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ --config string config file (default is path/config.yaml|json|toml)
-D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL
--config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files
--disableSitemap[=false]: Do not build Sitemap file
--editor="": edit new content with this editor, if provided
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-s, --source="": filesystem path to read files relative from
--stepAnalysis[=false]: display memory and timing of different steps of the program
-t, --theme="": theme to use (located in /themes/THEMENAME/)
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

18
docs/content/commands/hugo_convert.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo convert" title: "hugo convert"
slug: hugo_convert slug: hugo_convert
url: /commands/hugo_convert/ url: /commands/hugo_convert/
@ -18,18 +18,18 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### Options ### Options
``` ```
-o, --output="": filesystem path to write files to -o, --output string filesystem path to write files to
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--unsafe[=false]: enable less safe operations, please backup first --unsafe enable less safe operations, please backup first
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
@ -38,4 +38,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 toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML * [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

18
docs/content/commands/hugo_convert_toJSON.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo convert toJSON" title: "hugo convert toJSON"
slug: hugo_convert_toJSON slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/ url: /commands/hugo_convert_tojson/
@ -21,16 +21,16 @@ hugo convert toJSON
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-o, --output="": filesystem path to write files to -o, --output string filesystem path to write files to
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--unsafe[=false]: enable less safe operations, please backup first --unsafe enable less safe operations, please backup first
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

18
docs/content/commands/hugo_convert_toTOML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo convert toTOML" title: "hugo convert toTOML"
slug: hugo_convert_toTOML slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/ url: /commands/hugo_convert_totoml/
@ -21,16 +21,16 @@ hugo convert toTOML
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-o, --output="": filesystem path to write files to -o, --output string filesystem path to write files to
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--unsafe[=false]: enable less safe operations, please backup first --unsafe enable less safe operations, please backup first
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

18
docs/content/commands/hugo_convert_toYAML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo convert toYAML" title: "hugo convert toYAML"
slug: hugo_convert_toYAML slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/ url: /commands/hugo_convert_toyaml/
@ -21,16 +21,16 @@ hugo convert toYAML
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-o, --output="": filesystem path to write files to -o, --output string filesystem path to write files to
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
--unsafe[=false]: enable less safe operations, please backup first --unsafe enable less safe operations, please backup first
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

12
docs/content/commands/hugo_gen.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo gen" title: "hugo gen"
slug: hugo_gen slug: hugo_gen
url: /commands/hugo_gen/ url: /commands/hugo_gen/
@ -16,10 +16,10 @@ A collection of several useful generators.
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
@ -28,4 +28,4 @@ A collection of several useful generators.
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI. * [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 * [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

16
docs/content/commands/hugo_gen_autocomplete.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo gen autocomplete" title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/ url: /commands/hugo_gen_autocomplete/
@ -36,20 +36,20 @@ hugo gen autocomplete
### Options ### Options
``` ```
--completionfile="/etc/bash_completion.d/hugo.sh": Autocompletion file --completionfile string Autocompletion file (default "/etc/bash_completion.d/hugo.sh")
--type="bash": Autocompletion type (currently only bash supported) --type string Autocompletion type (currently only bash supported) (default "bash")
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_gen_doc.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo gen doc" title: "hugo gen doc"
slug: hugo_gen_doc slug: hugo_gen_doc
url: /commands/hugo_gen_doc/ url: /commands/hugo_gen_doc/
@ -26,19 +26,19 @@ hugo gen doc
### Options ### Options
``` ```
--dir="/tmp/hugodoc/": the directory to write the doc. --dir string the directory to write the doc. (default "/tmp/hugodoc/")
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_gen_man.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo gen man" title: "hugo gen man"
slug: hugo_gen_man slug: hugo_gen_man
url: /commands/hugo_gen_man/ url: /commands/hugo_gen_man/
@ -22,19 +22,19 @@ hugo gen man
### Options ### Options
``` ```
--dir="man/": the directory to write the man pages. --dir string the directory to write the man pages. (default "man/")
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

12
docs/content/commands/hugo_import.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo import" title: "hugo import"
slug: hugo_import slug: hugo_import
url: /commands/hugo_import/ url: /commands/hugo_import/
@ -18,14 +18,14 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll * [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_import_jekyll.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo import jekyll" title: "hugo import jekyll"
slug: hugo_import_jekyll slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/ url: /commands/hugo_import_jekyll/
@ -22,19 +22,19 @@ hugo import jekyll
### Options ### Options
``` ```
--force[=false]: Allow import into non-empty target directory --force Allow import into non-empty target directory
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo import](/commands/hugo_import/) - Import your site from others. * [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_list.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo list" title: "hugo list"
slug: hugo_list slug: hugo_list
url: /commands/hugo_list/ url: /commands/hugo_list/
@ -18,16 +18,16 @@ List requires a subcommand, e.g. `hugo list drafts`.
### Options ### Options
``` ```
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
@ -35,4 +35,4 @@ List requires a subcommand, e.g. `hugo list drafts`.
* [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts * [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future * [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_list_drafts.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo list drafts" title: "hugo list drafts"
slug: hugo_list_drafts slug: hugo_list_drafts
url: /commands/hugo_list_drafts/ url: /commands/hugo_list_drafts/
@ -20,14 +20,14 @@ hugo list drafts
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_list_future.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo list future" title: "hugo list future"
slug: hugo_list_future slug: hugo_list_future
url: /commands/hugo_list_future/ url: /commands/hugo_list_future/
@ -21,14 +21,14 @@ hugo list future
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

19
docs/content/commands/hugo_new.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo new" title: "hugo new"
slug: hugo_new slug: hugo_new
url: /commands/hugo_new/ url: /commands/hugo_new/
@ -25,18 +25,19 @@ hugo new [path]
### Options ### Options
``` ```
-f, --format="toml": frontmatter format --editor string edit new content with this editor, if provided
-k, --kind="": Content type to create -f, --format string frontmatter format (default "toml")
-s, --source="": filesystem path to read files relative from -k, --kind string Content type to create
-s, --source string filesystem path to read files relative from
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
@ -44,4 +45,4 @@ hugo new [path]
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme * [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

18
docs/content/commands/hugo_new_site.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo new site" title: "hugo new site"
slug: hugo_new_site slug: hugo_new_site
url: /commands/hugo_new_site/ url: /commands/hugo_new_site/
@ -22,21 +22,21 @@ hugo new site [path]
### Options ### Options
``` ```
--force[=false]: Init inside non-empty directory --force Init inside non-empty directory
-f, --format="toml": config & frontmatter format -f, --format string config & frontmatter format (default "toml")
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

14
docs/content/commands/hugo_new_theme.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo new theme" title: "hugo new theme"
slug: hugo_new_theme slug: hugo_new_theme
url: /commands/hugo_new_theme/ url: /commands/hugo_new_theme/
@ -23,14 +23,14 @@ hugo new theme [name]
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-s, --source="": filesystem path to read files relative from -s, --source string filesystem path to read files relative from
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

67
docs/content/commands/hugo_server.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo server" title: "hugo server"
slug: hugo_server slug: hugo_server
url: /commands/hugo_server/ url: /commands/hugo_server/
@ -31,44 +31,47 @@ hugo server
### Options ### Options
``` ```
--appendPort[=true]: append port to baseurl --appendPort append port to baseurl (default true)
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
--bind="127.0.0.1": interface to which the server will bind --bind string interface to which the server will bind (default "127.0.0.1")
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --canonifyURLs if true, all relative URLs will be canonicalized using baseURL
--config="": config file (default is path/config.yaml|json|toml) --cleanDestinationDir Remove files from destination not found in static directories
-d, --destination="": filesystem path to write files to --config string config file (default is path/config.yaml|json|toml)
--disableLiveReload[=false]: watch without enabling live browser reload on rebuild -c, --contentDir string filesystem path to content directory
--disableRSS[=false]: Do not build RSS files -d, --destination string filesystem path to write files to
--disableSitemap[=false]: Do not build Sitemap file --disableLiveReload watch without enabling live browser reload on rebuild
--editor="": edit new content with this editor, if provided --disableRSS Do not build RSS files
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it --disableSitemap Do not build Sitemap file
--meminterval=100: interval to poll memory usage (requires --memstats) --forceSyncStatic Copy all files when static is changed.
--memstats="": log memory usage to this file --ignoreCache Ignores the cache directory for reading but still writes to it
--noTimes[=false]: Don't sync modification time of files -l, --layoutDir string filesystem path to layout directory
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect --meminterval int interval to poll memory usage (requires --memstats) (default 100)
-p, --port=1313: port on which the server will listen --memstats string log memory usage to this file
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --noTimes Don't sync modification time of files
--renderToDisk[=false]: render to Destination path (default is render to memory & serve from there) --pluralizeListTitles Pluralize titles in lists using inflect (default true)
-s, --source="": filesystem path to read files relative from -p, --port int port on which the server will listen (default 1313)
--stepAnalysis[=false]: display memory and timing of different steps of the program --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
-t, --theme="": theme to use (located in /themes/THEMENAME/) --renderToDisk render to Destination path (default is render to memory & serve from there)
--uglyURLs[=false]: if true, use /filename.html instead of /filename/ -s, --source string filesystem path to read files relative from
-w, --watch[=true]: watch filesystem for changes and recreate as needed --stepAnalysis display memory and timing of different steps of the program
-t, --theme string theme to use (located in /themes/THEMENAME/)
--uglyURLs if true, use /filename.html instead of /filename/
-w, --watch watch filesystem for changes and recreate as needed (default true)
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

12
docs/content/commands/hugo_undraft.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo undraft" title: "hugo undraft"
slug: hugo_undraft slug: hugo_undraft
url: /commands/hugo_undraft/ url: /commands/hugo_undraft/
@ -22,13 +22,13 @@ hugo undraft path/to/content
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016

12
docs/content/commands/hugo_version.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2015-12-16T09:24:56-07:00 date: 2016-04-09T23:00:06+02:00
title: "hugo version" title: "hugo version"
slug: hugo_version slug: hugo_version
url: /commands/hugo_version/ url: /commands/hugo_version/
@ -20,13 +20,13 @@ hugo version
### Options inherited from parent commands ### Options inherited from parent commands
``` ```
--log[=false]: Enable Logging --log Enable Logging
--logFile="": Log File path (if set, logging enabled automatically) --logFile string Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output -v, --verbose verbose output
--verboseLog[=false]: verbose logging --verboseLog verbose logging
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 16-Dec-2015 ###### Auto generated by spf13/cobra on 9-Apr-2016