Skip to content

Commit

Permalink
Regenerate the commands section of doc
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyfok authored and tychoish committed Aug 13, 2017
1 parent 0894ec2 commit d6979af
Show file tree
Hide file tree
Showing 23 changed files with 106 additions and 379 deletions.
4 changes: 2 additions & 2 deletions docs/content/commands/hugo.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand Down Expand Up @@ -63,4 +63,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 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
24 changes: 12 additions & 12 deletions docs/content/commands/hugo_benchmark.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
Expand All @@ -20,39 +20,39 @@ hugo benchmark

### Options

```
-n, --count=13: number of times to build the site
--cpuprofile="": path/filename for the CPU profile file
--memprofile="": path/filename for the memory profile file
```

### 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)
-n, --count=13: number of times to build the site
--cpuprofile="": path/filename for the CPU profile file
-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)
--memprofile="": path/filename for the memory profile file
--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

```
--log[=false]: Enable Logging
--logFile="": Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra on 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
16 changes: 10 additions & 6 deletions docs/content/commands/hugo_check.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand All @@ -18,7 +18,7 @@ and will give feedback.
hugo check
```

### Options inherited from parent commands
### Options

```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
Expand All @@ -32,20 +32,24 @@ hugo check
--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/
```

### Options inherited from parent commands

```
--log[=false]: Enable Logging
--logFile="": Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings

###### Auto generated by spf13/cobra on 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
15 changes: 10 additions & 5 deletions docs/content/commands/hugo_config.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand All @@ -17,7 +17,7 @@ Print the site configuration, both default and custom settings.
hugo config
```

### Options inherited from parent commands
### Options

```
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
Expand All @@ -31,19 +31,24 @@ hugo config
--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/
```

### Options inherited from parent commands

```
--log[=false]: Enable Logging
--logFile="": Log File path (if set, logging enabled automatically)
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra on 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
22 changes: 3 additions & 19 deletions docs/content/commands/hugo_convert.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand All @@ -19,31 +19,15 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.

```
-o, --output="": filesystem path to write files to
-s, --source="": filesystem path to read files relative from
--unsafe[=false]: enable less safe operations, please backup first
```

### 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
```
Expand All @@ -54,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 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
20 changes: 2 additions & 18 deletions docs/content/commands/hugo_convert_toJSON.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand All @@ -21,26 +21,10 @@ hugo convert toJSON
### 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)
-o, --output="": filesystem path to write files to
--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/
--unsafe[=false]: enable less safe operations, please backup first
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
Expand All @@ -49,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 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
20 changes: 2 additions & 18 deletions docs/content/commands/hugo_convert_toTOML.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand All @@ -21,26 +21,10 @@ hugo convert toTOML
### 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)
-o, --output="": filesystem path to write files to
--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/
--unsafe[=false]: enable less safe operations, please backup first
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
Expand All @@ -49,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 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
20 changes: 2 additions & 18 deletions docs/content/commands/hugo_convert_toYAML.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand All @@ -21,26 +21,10 @@ hugo convert toYAML
### 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)
-o, --output="": filesystem path to write files to
--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/
--unsafe[=false]: enable less safe operations, please backup first
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
Expand All @@ -49,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 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015
21 changes: 2 additions & 19 deletions docs/content/commands/hugo_gen.md
@@ -1,5 +1,5 @@
---
date: 2015-11-25T23:10:39+01:00
date: 2015-12-11T09:49:10-07:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
Expand All @@ -16,25 +16,8 @@ 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
```
Expand All @@ -45,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 25-Nov-2015
###### Auto generated by spf13/cobra on 11-Dec-2015

0 comments on commit d6979af

Please sign in to comment.