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

docs: Regen commands doc

Browse source 
Fixes #2235
This commit is contained in:
Bjørn Erik Pedersen 2016-06-22 14:03:18 +02:00
parent 1accd3ba88
commit 29ca323a34
25 changed files with 97 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo"
slug: hugo
url: /commands/hugo/
@ -27,6 +27,7 @@ hugo
```
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
@ -34,10 +35,11 @@ hugo
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disable404 Do not render 404 page
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--ignoreCache Ignores the cache directory for reading but still writes to it
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
@ -55,7 +57,7 @@ hugo
```
### SEE ALSO
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark hugo by building a site a number of times.
* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times.
* [hugo check](/commands/hugo_check/) - Check content in the source directory
* [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
@ -67,4 +69,4 @@ hugo
* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False'
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,12 +1,12 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
---
## hugo benchmark
Benchmark hugo by building a site a number of times.
Benchmark Hugo by building a site a number of times.
### Synopsis
@ -23,6 +23,7 @@ hugo benchmark
```
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
@ -32,10 +33,11 @@ hugo benchmark
-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
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--ignoreCache Ignores the cache directory for reading but still writes to it
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--memprofile string path/filename for the memory profile file
--noTimes Don't sync modification time of files
@ -60,4 +62,4 @@ hugo benchmark
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@ -23,6 +23,7 @@ hugo check
```
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
@ -30,10 +31,11 @@ hugo check
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disable404 Do not render 404 page
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--ignoreCache Ignores the cache directory for reading but still writes to it
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--noTimes Don't sync modification time of files
--pluralizeListTitles Pluralize titles in lists using inflect (default true)
@ -57,4 +59,4 @@ hugo check
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@ -30,4 +30,4 @@ hugo check ulimit
### SEE ALSO
* [hugo check](/commands/hugo_check/) - Check content in the source directory
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@ -35,4 +35,4 @@ hugo config
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@ -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 toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@ -33,4 +33,4 @@ hugo convert toJSON
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@ -33,4 +33,4 @@ hugo convert toTOML
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@ -33,4 +33,4 @@ hugo convert toYAML
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
@ -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 man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
@ -52,4 +52,4 @@ hugo gen autocomplete
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
@ -41,4 +41,4 @@ hugo gen doc
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
@ -37,4 +37,4 @@ hugo gen man
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
@ -28,4 +28,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
@ -37,4 +37,4 @@ hugo import jekyll
### SEE ALSO
* [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
@ -33,6 +33,7 @@ List requires a subcommand, e.g. `hugo list drafts`.
### 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 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
@ -30,4 +30,4 @@ hugo list drafts
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

34
docs/content/commands/hugo_list_expired.md Normal file
View file

@ -0,0 +1,34 @@
---
date: 2016-06-22T14:03:03+02:00
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
---
## hugo list expired
List all posts already expired
### Synopsis
List all of the posts in your content directory which has already
expired.
```
hugo list expired
```
### Options inherited from parent commands
```
--log Enable Logging
--logFile string Log File path (if set, logging enabled automatically)
-s, --source string filesystem path to read files relative from
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
@ -31,4 +31,4 @@ hugo list future
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo new"
slug: hugo_new
url: /commands/hugo_new/
@ -45,4 +45,4 @@ hugo new [path]
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo new site"
slug: hugo_new_site
url: /commands/hugo_new_site/
@ -39,4 +39,4 @@ hugo new site [path]
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo new theme"
slug: hugo_new_theme
url: /commands/hugo_new_theme/
@ -33,4 +33,4 @@ hugo new theme [name]
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
@ -35,6 +35,7 @@ hugo server
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
--bind string interface to which the server will bind (default "127.0.0.1")
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--canonifyURLs if true, all relative URLs will be canonicalized using baseURL
@ -42,11 +43,12 @@ hugo server
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disable404 Do not render 404 page
--disableLiveReload watch without enabling live browser reload on rebuild
--disableRSS Do not build RSS files
--disableSitemap Do not build Sitemap file
--forceSyncStatic Copy all files when static is changed.
--ignoreCache Ignores the cache directory for reading but still writes to it
--ignoreCache Ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--meminterval int interval to poll memory usage (requires --memstats) (default 100)
--memstats string log memory usage to this file
@ -74,4 +76,4 @@ hugo server
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo undraft"
slug: hugo_undraft
url: /commands/hugo_undraft/
@ -31,4 +31,4 @@ hugo undraft path/to/content
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016

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

@ -1,5 +1,5 @@
---
date: 2016-04-09T23:00:06+02:00
date: 2016-06-22T14:03:03+02:00
title: "hugo version"
slug: hugo_version
url: /commands/hugo_version/
@ -29,4 +29,4 @@ hugo version
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 9-Apr-2016
###### Auto generated by spf13/cobra on 22-Jun-2016