Regenerate the commands section of doc

This commit is contained in:
Bjørn Erik Pedersen 2015-11-25 23:11:16 +01:00
parent d356720f74
commit f77a899ddd
24 changed files with 301 additions and 76 deletions

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo" title: "hugo"
slug: hugo slug: hugo
url: /commands/hugo/ url: /commands/hugo/
@ -29,6 +29,7 @@ hugo
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -54,12 +55,12 @@ hugo
* [hugo check](/commands/hugo_check/) - Check content in the source directory * [hugo check](/commands/hugo_check/) - Check content in the source directory
* [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo genautocomplete](/commands/hugo_genautocomplete/) - Generate shell autocompletion script for Hugo * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
* [hugo gendoc](/commands/hugo_gendoc/) - Generate Markdown documentation for the Hugo CLI. * [hugo import](/commands/hugo_import/) - Import your site from others.
* [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo list](/commands/hugo_list/) - Listing out various types of content
* [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo new](/commands/hugo_new/) - Create new content for your site
* [hugo server](/commands/hugo_server/) - Hugo runs its own webserver to render the files * [hugo server](/commands/hugo_server/) - A high performance webserver
* [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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo benchmark" title: "hugo benchmark"
slug: hugo_benchmark slug: hugo_benchmark
url: /commands/hugo_benchmark/ url: /commands/hugo_benchmark/
@ -33,6 +33,7 @@ hugo benchmark
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -54,4 +55,4 @@ hugo benchmark
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo check" title: "hugo check"
slug: hugo_check slug: hugo_check
url: /commands/hugo_check/ url: /commands/hugo_check/
@ -25,6 +25,7 @@ hugo check
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -45,5 +46,6 @@ hugo check
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -0,0 +1,50 @@
---
date: 2015-11-25T23:10:39+01:00
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
---
## hugo check ulimit
Check system ulimit settings
### 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
```
hugo check ulimit
```
### Options inherited from parent commands
```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
-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
--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
* [hugo check](/commands/hugo_check/) - Check content in the source directory
###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo config" title: "hugo config"
slug: hugo_config slug: hugo_config
url: /commands/hugo_config/ url: /commands/hugo_config/
@ -24,6 +24,7 @@ hugo config
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -45,4 +46,4 @@ hugo config
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo convert" title: "hugo convert"
slug: hugo_convert slug: hugo_convert
url: /commands/hugo_convert/ url: /commands/hugo_convert/
@ -29,6 +29,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -53,4 +54,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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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/
@ -25,6 +25,7 @@ hugo convert toJSON
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -48,4 +49,4 @@ hugo convert toJSON
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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/
@ -25,6 +25,7 @@ hugo convert toTOML
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -48,4 +49,4 @@ hugo convert toTOML
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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/
@ -25,6 +25,7 @@ hugo convert toYAML
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -48,4 +49,4 @@ hugo convert toYAML
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -0,0 +1,48 @@
---
date: 2015-11-25T23:10:39+01:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
---
## hugo gen
A collection of several useful generators.
### Synopsis
A collection of several useful generators.
### Options inherited from parent commands
```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
-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
--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
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo
* [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 25-Nov-2015

View file

@ -1,10 +1,10 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo genautocomplete" title: "hugo gen autocomplete"
slug: hugo_genautocomplete slug: hugo_gen_autocomplete
url: /commands/hugo_genautocomplete/ url: /commands/hugo_gen_autocomplete/
--- ---
## hugo genautocomplete ## hugo gen autocomplete
Generate shell autocompletion script for Hugo Generate shell autocompletion script for Hugo
@ -30,7 +30,7 @@ or just source them in directly:
$ . /etc/bash_completion $ . /etc/bash_completion
``` ```
hugo genautocomplete hugo gen autocomplete
``` ```
### Options ### Options
@ -47,6 +47,7 @@ hugo genautocomplete
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -66,6 +67,6 @@ hugo genautocomplete
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,10 +1,10 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo gendoc" title: "hugo gen doc"
slug: hugo_gendoc slug: hugo_gen_doc
url: /commands/hugo_gendoc/ url: /commands/hugo_gen_doc/
--- ---
## hugo gendoc ## hugo gen doc
Generate Markdown documentation for the Hugo CLI. Generate Markdown documentation for the Hugo CLI.
@ -20,7 +20,7 @@ It creates one Markdown file per command with front matter suitable
for rendering in Hugo. for rendering in Hugo.
``` ```
hugo gendoc hugo gen doc
``` ```
### Options ### Options
@ -36,6 +36,7 @@ hugo gendoc
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -55,6 +56,6 @@ hugo gendoc
``` ```
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -0,0 +1,51 @@
---
date: 2015-11-25T23:10:39+01:00
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
---
## hugo gen man
Generate man pages for the Hugo CLI
### 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.
```
hugo gen man
```
### Options inherited from parent commands
```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
-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
--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
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,28 +1,19 @@
--- ---
date: 2015-08-04T03:11:10-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo help" title: "hugo import"
slug: hugo_help slug: hugo_import
url: /commands/hugo_help/ url: /commands/hugo_import/
--- ---
## hugo help ## hugo import
Help about any command Import your site from others.
### Synopsis ### Synopsis
Help provides help for any command in the application. Import your site from other web site generators like Jekyll.
Simply type hugo help [path to command] for full details.
``` Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
hugo help [command]
```
### Options
```
-h, --help[=false]: help for help
```
### Options inherited from parent commands ### Options inherited from parent commands
@ -31,6 +22,7 @@ hugo help [command]
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -51,5 +43,6 @@ hugo help [command]
### 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
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -0,0 +1,51 @@
---
date: 2015-11-25T23:10:39+01:00
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
---
## hugo import jekyll
hugo import from Jekyll
### Synopsis
hugo import from Jekyll.
Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`.
```
hugo import jekyll
```
### Options inherited from parent commands
```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
-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
--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
* [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo list" title: "hugo list"
slug: hugo_list slug: hugo_list
url: /commands/hugo_list/ url: /commands/hugo_list/
@ -22,6 +22,7 @@ List requires a subcommand, e.g. `hugo list drafts`.
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -45,4 +46,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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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/
@ -24,6 +24,7 @@ hugo list drafts
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -45,4 +46,4 @@ hugo list drafts
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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/
@ -25,6 +25,7 @@ hugo list future
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -46,4 +47,4 @@ hugo list future
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo new" title: "hugo new"
slug: hugo_new slug: hugo_new
url: /commands/hugo_new/ url: /commands/hugo_new/
@ -36,6 +36,7 @@ hugo new [path]
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -59,4 +60,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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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,6 +22,7 @@ hugo new site [path]
### Options ### Options
``` ```
--force[=false]: Init inside non-empty directory
-f, --format="toml": config & frontmatter format -f, --format="toml": config & frontmatter format
``` ```
@ -32,6 +33,7 @@ hugo new site [path]
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -53,4 +55,4 @@ hugo new site [path]
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01: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/
@ -27,6 +27,7 @@ hugo new theme [name]
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -48,4 +49,4 @@ hugo new theme [name]
### 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 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,19 +1,28 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo server" title: "hugo server"
slug: hugo_server slug: hugo_server
url: /commands/hugo_server/ url: /commands/hugo_server/
--- ---
## hugo server ## hugo server
Hugo runs its own webserver to render the files A high performance webserver
### Synopsis ### Synopsis
Hugo is able to run its own high performance web server. Hugo provides its own webserver which builds and serves the site.
Hugo will render all the files defined in the source directory and While hugo server is high performance, it is a webserver with limited options.
serve them up. Many run it in production, but the standard behavior is for people to use it
in development and use a more full featured server such as Nginx or Caddy.
'hugo server' will avoid writing the rendered and served content to disk,
preferring to store it in memory.
By default hugo will also watch your files for any changes you make and
automatically rebuild the site. It will then live reload any open browser pages
and push the latest content to them. As most Hugo sites are built in a fraction
of a second, you will be able to save and see your changes nearly instantly.
``` ```
hugo server hugo server
@ -27,8 +36,10 @@ hugo server
--disableLiveReload[=false]: watch without enabling live browser reload on rebuild --disableLiveReload[=false]: watch without enabling live browser reload on rebuild
--meminterval=100: interval to poll memory usage (requires --memstats) --meminterval=100: interval to poll memory usage (requires --memstats)
--memstats="": log memory usage to this file --memstats="": log memory usage to this file
--noTimes[=false]: Don't sync modification time of files
-p, --port=1313: port on which the server will listen -p, --port=1313: port on which the server will listen
-w, --watch[=false]: watch filesystem for changes and recreate as needed --renderToDisk[=false]: render to Destination path (default is render to memory & serve from there)
-w, --watch[=true]: watch filesystem for changes and recreate as needed
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -38,6 +49,7 @@ hugo server
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -59,4 +71,4 @@ hugo server
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo undraft" title: "hugo undraft"
slug: hugo_undraft slug: hugo_undraft
url: /commands/hugo_undraft/ url: /commands/hugo_undraft/
@ -26,6 +26,7 @@ hugo undraft path/to/content
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -47,4 +48,4 @@ hugo undraft path/to/content
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015

View file

@ -1,5 +1,5 @@
--- ---
date: 2015-09-08T22:45:13-06:00 date: 2015-11-25T23:10:39+01:00
title: "hugo version" title: "hugo version"
slug: hugo_version slug: hugo_version
url: /commands/hugo_version/ url: /commands/hugo_version/
@ -24,6 +24,7 @@ hugo version
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
-F, --buildFuture[=false]: include content with publishdate in the future -F, --buildFuture[=false]: include content with publishdate in the future
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --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) --config="": config file (default is path/config.yaml|json|toml)
-d, --destination="": filesystem path to write files to -d, --destination="": filesystem path to write files to
--disableRSS[=false]: Do not build RSS files --disableRSS[=false]: Do not build RSS files
@ -45,4 +46,4 @@ hugo version
### SEE ALSO ### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 8-Sep-2015 ###### Auto generated by spf13/cobra on 25-Nov-2015