Skip to content

Commit

Permalink
docs: Re-generate CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Jan 25, 2018
1 parent d418c2c commit 1e27d05
Show file tree
Hide file tree
Showing 27 changed files with 81 additions and 90 deletions.
9 changes: 3 additions & 6 deletions docs/content/commands/hugo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand All @@ -10,7 +10,6 @@ hugo builds your site

### Synopsis


hugo is the main command, used to build your Hugo site.

Hugo is a Fast and Flexible Static Site Generator
Expand All @@ -36,10 +35,7 @@ hugo [flags]
-c, --contentDir string filesystem path to content directory
--debug debug output
-d, --destination string filesystem path to write files to
--disable404 do not render 404 page
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableRSS do not build RSS files
--disableSitemap do not build Sitemap file
--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
Expand Down Expand Up @@ -68,6 +64,7 @@ hugo [flags]
```

### SEE ALSO

* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times.
* [hugo check](/commands/hugo_check/) - Contains some verification checks
* [hugo config](/commands/hugo_config/) - Print the site configuration
Expand All @@ -81,4 +78,4 @@ hugo [flags]
* [hugo undraft](/commands/hugo_undraft/) - Undraft resets the content's draft status
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
9 changes: 3 additions & 6 deletions docs/content/commands/hugo_benchmark.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
Expand All @@ -10,7 +10,6 @@ Benchmark Hugo by building a site a number of times.

### Synopsis


Hugo can build a site many times over and analyze the running process
creating a benchmark.

Expand All @@ -32,10 +31,7 @@ hugo benchmark [flags]
-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
--disableKinds stringSlice disable different kind of pages (home, RSS etc.)
--disableRSS do not build RSS files
--disableSitemap do not build Sitemap file
--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
Expand Down Expand Up @@ -71,6 +67,7 @@ hugo benchmark [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand All @@ -10,7 +10,6 @@ Contains some verification checks

### Synopsis


Contains some verification checks

### Options
Expand All @@ -32,7 +31,8 @@ Contains some verification checks
```

### 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 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_check_ulimit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
Expand All @@ -10,7 +10,6 @@ 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

Expand All @@ -37,6 +36,7 @@ hugo check ulimit [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand All @@ -10,7 +10,6 @@ Print the site configuration

### Synopsis


Print the site configuration, both default and custom settings.

```
Expand All @@ -36,6 +35,7 @@ hugo config [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_convert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand All @@ -10,7 +10,6 @@ Convert your content to different formats

### Synopsis


Convert your content (e.g. front matter) to different formats.

See convert's subcommands toJSON, toTOML and toYAML for more information.
Expand All @@ -37,9 +36,10 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
```

### SEE ALSO

* [hugo](/commands/hugo/) - hugo builds your site
* [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON
* [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 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand All @@ -10,7 +10,6 @@ Convert front matter to JSON

### Synopsis


toJSON converts all front matter in the content directory
to use JSON for the front matter.

Expand Down Expand Up @@ -40,6 +39,7 @@ hugo convert toJSON [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand All @@ -10,7 +10,6 @@ Convert front matter to TOML

### Synopsis


toTOML converts all front matter in the content directory
to use TOML for the front matter.

Expand Down Expand Up @@ -40,6 +39,7 @@ hugo convert toTOML [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand All @@ -10,7 +10,6 @@ Convert front matter to YAML

### Synopsis


toYAML converts all front matter in the content directory
to use YAML for the front matter.

Expand Down Expand Up @@ -40,6 +39,7 @@ hugo convert toYAML [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
Expand All @@ -10,7 +10,6 @@ Print Hugo version and environment info

### Synopsis


Print Hugo version and environment info. This is useful in Hugo bug reports.

```
Expand All @@ -36,6 +35,7 @@ hugo env [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_gen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
Expand All @@ -10,7 +10,6 @@ A collection of several useful generators.

### Synopsis


A collection of several useful generators.

### Options
Expand All @@ -32,10 +31,11 @@ A collection of several useful generators.
```

### SEE ALSO

* [hugo](/commands/hugo/) - hugo builds your site
* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo
* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter
* [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 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_gen_autocomplete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
Expand All @@ -10,7 +10,6 @@ Generate shell autocompletion script for Hugo

### Synopsis


Generates a shell autocompletion script for Hugo.

NOTE: The current version supports Bash only.
Expand Down Expand Up @@ -54,6 +53,7 @@ hugo gen autocomplete [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_gen_chromastyles.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles
url: /commands/hugo_gen_chromastyles/
Expand All @@ -10,7 +10,6 @@ Generate CSS stylesheet for the Chroma code highlighter

### Synopsis


Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config.

See https://help.farbox.com/pygments.html for preview of available styles
Expand Down Expand Up @@ -41,6 +40,7 @@ hugo gen chromastyles [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_gen_doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
Expand All @@ -10,7 +10,6 @@ Generate Markdown documentation for the Hugo CLI.

### Synopsis


Generate Markdown documentation for the Hugo CLI.

This command is, mostly, used to create up-to-date documentation
Expand Down Expand Up @@ -43,6 +42,7 @@ hugo gen doc [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
6 changes: 3 additions & 3 deletions docs/content/commands/hugo_gen_man.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2017-12-28T18:49:29+01:00
date: 2018-01-25T10:24:52+01:00
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
Expand All @@ -10,7 +10,6 @@ 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.
Expand Down Expand Up @@ -39,6 +38,7 @@ hugo gen man [flags]
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2017
###### Auto generated by spf13/cobra on 25-Jan-2018
Loading

0 comments on commit 1e27d05

Please sign in to comment.