Skip to content

Commit

Permalink
docs: Regenerate CLI docs
Browse files Browse the repository at this point in the history
Fixes #5507
  • Loading branch information
bep committed Dec 12, 2018
1 parent b17a61a commit 5068681
Show file tree
Hide file tree
Showing 26 changed files with 298 additions and 245 deletions.
6 changes: 4 additions & 2 deletions docs/content/en/commands/hugo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand Down Expand Up @@ -31,11 +31,13 @@ hugo [flags]
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
-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
-e, --environment string build environment
--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
Expand Down Expand Up @@ -74,4 +76,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 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
20 changes: 11 additions & 9 deletions docs/content/en/commands/hugo_benchmark.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
Expand Down Expand Up @@ -32,6 +32,7 @@ hugo benchmark [flags]
-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
-e, --environment string build environment
--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
Expand All @@ -54,17 +55,18 @@ hugo benchmark [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
19 changes: 10 additions & 9 deletions docs/content/en/commands/hugo_check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand All @@ -21,18 +21,19 @@ Contains some verification checks
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog 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 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
19 changes: 10 additions & 9 deletions docs/content/en/commands/hugo_check_ulimit.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
Expand All @@ -26,17 +26,18 @@ hugo check ulimit [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
19 changes: 10 additions & 9 deletions docs/content/en/commands/hugo_config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand All @@ -26,17 +26,18 @@ hugo config [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
19 changes: 10 additions & 9 deletions docs/content/en/commands/hugo_convert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand All @@ -26,13 +26,14 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO
Expand All @@ -42,4 +43,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 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
25 changes: 13 additions & 12 deletions docs/content/en/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand All @@ -26,20 +26,21 @@ hugo convert toJSON [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
25 changes: 13 additions & 12 deletions docs/content/en/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand All @@ -26,20 +26,21 @@ hugo convert toTOML [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
25 changes: 13 additions & 12 deletions docs/content/en/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand All @@ -26,20 +26,21 @@ hugo convert toYAML [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
-o, --output string filesystem path to write files to
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--unsafe enable less safe operations, please backup first
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
19 changes: 10 additions & 9 deletions docs/content/en/commands/hugo_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
Expand All @@ -25,17 +25,18 @@ hugo env [flags]
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
19 changes: 10 additions & 9 deletions docs/content/en/commands/hugo_gen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2018-11-05
date: 2018-12-12
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
Expand All @@ -21,13 +21,14 @@ A collection of several useful generators.
### Options inherited from parent commands

```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```

### SEE ALSO
Expand All @@ -38,4 +39,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 5-Nov-2018
###### Auto generated by spf13/cobra on 12-Dec-2018
Loading

0 comments on commit 5068681

Please sign in to comment.