Skip to content

Commit

Permalink
Complete the Url-to-URL transition in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyfok authored and tychoish committed Aug 13, 2017
1 parent 49354cf commit 3db506c
Show file tree
Hide file tree
Showing 25 changed files with 87 additions and 162 deletions.
10 changes: 4 additions & 6 deletions docs/content/commands/hugo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo"
slug: hugo
url: /commands/hugo/
Expand All @@ -25,7 +25,7 @@ hugo
### Options

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -34,7 +34,6 @@ hugo
--disableRSS[=false]: Do not build RSS files
--disableSitemap[=false]: Do not build Sitemap file
--editor="": edit new content with this editor, if provided
-h, --help[=false]: help for hugo
--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)
Expand All @@ -44,7 +43,7 @@ hugo
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
-w, --watch[=false]: watch filesystem for changes and recreate as needed
Expand All @@ -57,11 +56,10 @@ hugo
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo genautocomplete](/commands/hugo_genautocomplete/) - Generate shell autocompletion script for Hugo
* [hugo gendoc](/commands/hugo_gendoc/) - Generate Markdown documentation for the Hugo CLI.
* [hugo help](/commands/hugo_help/) - Help about any command
* [hugo list](/commands/hugo_list/) - Listing out various types of content
* [hugo new](/commands/hugo_new/) - Create new content for your site
* [hugo server](/commands/hugo_server/) - Hugo runs its own webserver to render the files
* [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 at 2015-08-04 09:11:10.032773309 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
9 changes: 4 additions & 5 deletions docs/content/commands/hugo_benchmark.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
Expand All @@ -23,14 +23,13 @@ hugo benchmark
```
-n, --count=13: number of times to build the site
--cpuprofile="": path/filename for the CPU profile file
-h, --help[=false]: help for benchmark
--memprofile="": path/filename for the memory profile file
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -47,12 +46,12 @@ hugo benchmark
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.029178075 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
14 changes: 4 additions & 10 deletions docs/content/commands/hugo_check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
Expand All @@ -18,16 +18,10 @@ and will give feedback.
hugo check
```

### Options

```
-h, --help[=false]: help for check
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -44,12 +38,12 @@ hugo check
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.028981006 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
14 changes: 4 additions & 10 deletions docs/content/commands/hugo_config.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
Expand All @@ -17,16 +17,10 @@ Print the site configuration, both default and custom settings.
hugo config
```

### Options

```
-h, --help[=false]: help for config
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -43,12 +37,12 @@ hugo config
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.028773512 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
9 changes: 4 additions & 5 deletions docs/content/commands/hugo_convert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
Expand All @@ -18,15 +18,14 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
### Options

```
-h, --help[=false]: help for convert
-o, --output="": filesystem path to write files to
--unsafe[=false]: enable less safe operations, please backup first
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -43,7 +42,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```
Expand All @@ -54,4 +53,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 at 2015-08-04 09:11:10.029941981 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
14 changes: 4 additions & 10 deletions docs/content/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
Expand All @@ -18,16 +18,10 @@ to use JSON for the front matter.
hugo convert toJSON
```

### Options

```
-h, --help[=false]: help for toJSON
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -45,7 +39,7 @@ hugo convert toJSON
-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/
--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 @@ -54,4 +48,4 @@ hugo convert toJSON
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.029372273 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
14 changes: 4 additions & 10 deletions docs/content/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
Expand All @@ -18,16 +18,10 @@ to use TOML for the front matter.
hugo convert toTOML
```

### Options

```
-h, --help[=false]: help for toTOML
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -45,7 +39,7 @@ hugo convert toTOML
-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/
--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 @@ -54,4 +48,4 @@ hugo convert toTOML
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.029568477 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
14 changes: 4 additions & 10 deletions docs/content/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
Expand All @@ -18,16 +18,10 @@ to use YAML for the front matter.
hugo convert toYAML
```

### Options

```
-h, --help[=false]: help for toYAML
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -45,7 +39,7 @@ hugo convert toYAML
-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/
--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 @@ -54,4 +48,4 @@ hugo convert toYAML
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.029752904 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
9 changes: 4 additions & 5 deletions docs/content/commands/hugo_genautocomplete.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo genautocomplete"
slug: hugo_genautocomplete
url: /commands/hugo_genautocomplete/
Expand Down Expand Up @@ -37,14 +37,13 @@ hugo genautocomplete

```
--completionfile="/etc/bash_completion.d/hugo.sh": Autocompletion file
-h, --help[=false]: help for genautocomplete
--type="bash": Autocompletion type (currently only bash supported)
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -61,12 +60,12 @@ hugo genautocomplete
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.032217938 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
9 changes: 4 additions & 5 deletions docs/content/commands/hugo_gendoc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2015-08-04T03:11:10-06:00
date: 2015-09-08T22:45:13-06:00
title: "hugo gendoc"
slug: hugo_gendoc
url: /commands/hugo_gendoc/
Expand Down Expand Up @@ -27,13 +27,12 @@ hugo gendoc

```
--dir="/tmp/hugodoc/": the directory to write the doc.
-h, --help[=false]: help for gendoc
```

### Options inherited from parent commands

```
-b, --baseUrl="": hostname (and path) to the root eg. http://spf13.com/
-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/
Expand All @@ -50,12 +49,12 @@ hugo gendoc
-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/
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
-v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging
```

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

###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.032407873 +0000 UTC
###### Auto generated by spf13/cobra on 8-Sep-2015
Loading

0 comments on commit 3db506c

Please sign in to comment.