Skip to content

Commit

Permalink
docs: Regenerate CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Aug 17, 2018
1 parent d2c8b72 commit 86a7ae4
Show file tree
Hide file tree
Showing 26 changed files with 162 additions and 161 deletions.
79 changes: 40 additions & 39 deletions content/en/commands/hugo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand All @@ -24,43 +24,44 @@ hugo [flags]
### Options

```
-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 (deprecated) if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
--debug debug output
-d, --destination string filesystem path to write files to
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for hugo
--i18n-warnings print missing translations
--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)
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--pluralizeListTitles (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--quiet build in quiet mode
--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
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--uglyURLs (deprecated) 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
-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 (deprecated) if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml)
-c, --contentDir string filesystem path to content directory
--debug debug output
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for hugo
--i18n-warnings print missing translations
--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)
--minify minify any supported output format (HTML, XML etc.)
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--pluralizeListTitles (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
--quiet build in quiet mode
--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
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--uglyURLs (deprecated) 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
Expand All @@ -77,4 +78,4 @@ hugo [flags]
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
68 changes: 34 additions & 34 deletions content/en/commands/hugo_benchmark.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
Expand All @@ -20,38 +20,38 @@ hugo benchmark [flags]
### Options

```
-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 (deprecated) if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory
-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
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for benchmark
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--memprofile string path/filename for the memory profile file
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--pluralizeListTitles (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) 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
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--uglyURLs (deprecated) if true, use /filename.html instead of /filename/
-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 (deprecated) if true, all relative URLs will be canonicalized using baseURL
--cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory
-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
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for benchmark
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--memprofile string path/filename for the memory profile file
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--pluralizeListTitles (deprecated) pluralize titles in lists using inflect (default true)
--preserveTaxonomyNames (deprecated) 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
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--uglyURLs (deprecated) if true, use /filename.html instead of /filename/
```

### Options inherited from parent commands
Expand All @@ -70,4 +70,4 @@ hugo benchmark [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand Down Expand Up @@ -35,4 +35,4 @@ Contains some verification checks
* [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-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_check_ulimit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
Expand Down Expand Up @@ -39,4 +39,4 @@ hugo check ulimit [flags]

* [hugo check](/commands/hugo_check/) - Contains some verification checks

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand Down Expand Up @@ -39,4 +39,4 @@ hugo config [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand Down Expand Up @@ -42,4 +42,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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand Down Expand Up @@ -42,4 +42,4 @@ hugo convert toJSON [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand Down Expand Up @@ -42,4 +42,4 @@ hugo convert toTOML [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand Down Expand Up @@ -42,4 +42,4 @@ hugo convert toYAML [flags]

* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
Expand Down Expand Up @@ -38,4 +38,4 @@ hugo env [flags]

* [hugo](/commands/hugo/) - hugo builds your site

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
Expand Down Expand Up @@ -38,4 +38,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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_autocomplete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
Expand Down Expand Up @@ -56,4 +56,4 @@ hugo gen autocomplete [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_chromastyles.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
Expand Down Expand Up @@ -43,4 +43,4 @@ hugo gen chromastyles [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
Expand Down Expand Up @@ -45,4 +45,4 @@ hugo gen doc [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_gen_man.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
Expand Down Expand Up @@ -41,4 +41,4 @@ hugo gen man [flags]

* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_import.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
Expand Down Expand Up @@ -37,4 +37,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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_import_jekyll.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
Expand Down Expand Up @@ -41,4 +41,4 @@ hugo import jekyll [flags]

* [hugo import](/commands/hugo_import/) - Import your site from others.

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
Expand Down Expand Up @@ -40,4 +40,4 @@ List requires a subcommand, e.g. `hugo list 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 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
4 changes: 2 additions & 2 deletions content/en/commands/hugo_list_drafts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-04-16
date: 2018-08-17
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
Expand Down Expand Up @@ -39,4 +39,4 @@ hugo list drafts [flags]

* [hugo list](/commands/hugo_list/) - Listing out various types of content

###### Auto generated by spf13/cobra on 16-Apr-2018
###### Auto generated by spf13/cobra on 17-Aug-2018
Loading

0 comments on commit 86a7ae4

Please sign in to comment.