From 3db506c7eba7cb21129bbc7584b5579e7a5d75cd Mon Sep 17 00:00:00 2001 From: Anthony Fok Date: Tue, 8 Sep 2015 23:29:04 -0600 Subject: [PATCH] Complete the Url-to-URL transition in docs See #959 --- docs/content/commands/hugo.md | 10 ++++------ docs/content/commands/hugo_benchmark.md | 9 ++++----- docs/content/commands/hugo_check.md | 14 ++++---------- docs/content/commands/hugo_config.md | 14 ++++---------- docs/content/commands/hugo_convert.md | 9 ++++----- docs/content/commands/hugo_convert_toJSON.md | 14 ++++---------- docs/content/commands/hugo_convert_toTOML.md | 14 ++++---------- docs/content/commands/hugo_convert_toYAML.md | 14 ++++---------- docs/content/commands/hugo_genautocomplete.md | 9 ++++----- docs/content/commands/hugo_gendoc.md | 9 ++++----- docs/content/commands/hugo_help.md | 6 +++--- docs/content/commands/hugo_list.md | 14 ++++---------- docs/content/commands/hugo_list_drafts.md | 14 ++++---------- docs/content/commands/hugo_list_future.md | 14 ++++---------- docs/content/commands/hugo_new.md | 9 ++++----- docs/content/commands/hugo_new_site.md | 9 ++++----- docs/content/commands/hugo_new_theme.md | 14 ++++---------- docs/content/commands/hugo_server.md | 9 ++++----- docs/content/commands/hugo_undraft.md | 14 ++++---------- docs/content/commands/hugo_version.md | 14 ++++---------- docs/content/content/organization.md | 4 ++-- docs/content/extras/aliases.md | 2 +- docs/content/extras/urls.md | 2 +- docs/content/overview/configuration.md | 2 +- docs/content/overview/usage.md | 6 +++--- 25 files changed, 87 insertions(+), 162 deletions(-) diff --git a/docs/content/commands/hugo.md b/docs/content/commands/hugo.md index daba877a3ce..2a9231c0ff4 100644 --- a/docs/content/commands/hugo.md +++ b/docs/content/commands/hugo.md @@ -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/ @@ -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/ @@ -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) @@ -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 @@ -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 diff --git a/docs/content/commands/hugo_benchmark.md b/docs/content/commands/hugo_benchmark.md index f6722da8fbc..fbc59bce5d1 100644 --- a/docs/content/commands/hugo_benchmark.md +++ b/docs/content/commands/hugo_benchmark.md @@ -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/ @@ -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/ @@ -47,7 +46,7 @@ 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 ``` @@ -55,4 +54,4 @@ hugo benchmark ### 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 diff --git a/docs/content/commands/hugo_check.md b/docs/content/commands/hugo_check.md index 9c6638558f8..b8f44d903b3 100644 --- a/docs/content/commands/hugo_check.md +++ b/docs/content/commands/hugo_check.md @@ -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/ @@ -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/ @@ -44,7 +38,7 @@ 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 ``` @@ -52,4 +46,4 @@ hugo check ### 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 diff --git a/docs/content/commands/hugo_config.md b/docs/content/commands/hugo_config.md index de1a8d65736..f77b7665a54 100644 --- a/docs/content/commands/hugo_config.md +++ b/docs/content/commands/hugo_config.md @@ -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/ @@ -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/ @@ -43,7 +37,7 @@ 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 ``` @@ -51,4 +45,4 @@ hugo config ### 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 diff --git a/docs/content/commands/hugo_convert.md b/docs/content/commands/hugo_convert.md index 2532ab71b77..2e731529600 100644 --- a/docs/content/commands/hugo_convert.md +++ b/docs/content/commands/hugo_convert.md @@ -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/ @@ -18,7 +18,6 @@ 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 ``` @@ -26,7 +25,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. ### 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/ @@ -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 ``` @@ -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 diff --git a/docs/content/commands/hugo_convert_toJSON.md b/docs/content/commands/hugo_convert_toJSON.md index c3074445c82..786a7192498 100644 --- a/docs/content/commands/hugo_convert_toJSON.md +++ b/docs/content/commands/hugo_convert_toJSON.md @@ -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/ @@ -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/ @@ -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 @@ -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 diff --git a/docs/content/commands/hugo_convert_toTOML.md b/docs/content/commands/hugo_convert_toTOML.md index 072f1ef1481..0884d247074 100644 --- a/docs/content/commands/hugo_convert_toTOML.md +++ b/docs/content/commands/hugo_convert_toTOML.md @@ -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/ @@ -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/ @@ -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 @@ -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 diff --git a/docs/content/commands/hugo_convert_toYAML.md b/docs/content/commands/hugo_convert_toYAML.md index fc7bb688f97..e0e248b1398 100644 --- a/docs/content/commands/hugo_convert_toYAML.md +++ b/docs/content/commands/hugo_convert_toYAML.md @@ -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/ @@ -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/ @@ -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 @@ -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 diff --git a/docs/content/commands/hugo_genautocomplete.md b/docs/content/commands/hugo_genautocomplete.md index d516f313353..18f00f91b97 100644 --- a/docs/content/commands/hugo_genautocomplete.md +++ b/docs/content/commands/hugo_genautocomplete.md @@ -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/ @@ -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/ @@ -61,7 +60,7 @@ 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 ``` @@ -69,4 +68,4 @@ hugo genautocomplete ### 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 diff --git a/docs/content/commands/hugo_gendoc.md b/docs/content/commands/hugo_gendoc.md index e962111ab52..8534ad55696 100644 --- a/docs/content/commands/hugo_gendoc.md +++ b/docs/content/commands/hugo_gendoc.md @@ -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/ @@ -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/ @@ -50,7 +49,7 @@ 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 ``` @@ -58,4 +57,4 @@ hugo gendoc ### 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 diff --git a/docs/content/commands/hugo_help.md b/docs/content/commands/hugo_help.md index d9b129bfe5a..3ec4c8b81cc 100644 --- a/docs/content/commands/hugo_help.md +++ b/docs/content/commands/hugo_help.md @@ -27,7 +27,7 @@ hugo help [command] ### 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/ @@ -44,7 +44,7 @@ hugo help [command] -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 ``` @@ -52,4 +52,4 @@ hugo help [command] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.032577924 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_list.md b/docs/content/commands/hugo_list.md index 7fe96f884fc..91388d35a70 100644 --- a/docs/content/commands/hugo_list.md +++ b/docs/content/commands/hugo_list.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo list" slug: hugo_list url: /commands/hugo_list/ @@ -15,16 +15,10 @@ Listing out various types of content. List requires a subcommand, e.g. `hugo list drafts`. -### Options - -``` - -h, --help[=false]: help for list -``` - ### 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/ @@ -41,7 +35,7 @@ List requires a subcommand, e.g. `hugo list drafts`. -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 ``` @@ -51,4 +45,4 @@ List requires a subcommand, e.g. `hugo list drafts`. * [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts * [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.031129252 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_list_drafts.md b/docs/content/commands/hugo_list_drafts.md index 8def2e6fee6..2bd8be52723 100644 --- a/docs/content/commands/hugo_list_drafts.md +++ b/docs/content/commands/hugo_list_drafts.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ @@ -17,16 +17,10 @@ List all of the drafts in your content directory. hugo list drafts ``` -### Options - -``` - -h, --help[=false]: help for drafts -``` - ### 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/ @@ -43,7 +37,7 @@ hugo list drafts -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 ``` @@ -51,4 +45,4 @@ hugo list drafts ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.030650499 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_list_future.md b/docs/content/commands/hugo_list_future.md index 44d1a9e24e9..d7329808a0b 100644 --- a/docs/content/commands/hugo_list_future.md +++ b/docs/content/commands/hugo_list_future.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ @@ -18,16 +18,10 @@ posted in the future. hugo list future ``` -### Options - -``` - -h, --help[=false]: help for future -``` - ### 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/ @@ -44,7 +38,7 @@ hugo list future -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 ``` @@ -52,4 +46,4 @@ hugo list future ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.030877499 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_new.md b/docs/content/commands/hugo_new.md index 781b235cf07..a0ede3659b5 100644 --- a/docs/content/commands/hugo_new.md +++ b/docs/content/commands/hugo_new.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo new" slug: hugo_new url: /commands/hugo_new/ @@ -26,14 +26,13 @@ hugo new [path] ``` -f, --format="toml": frontmatter format - -h, --help[=false]: help for new -k, --kind="": Content type to create ``` ### 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/ @@ -50,7 +49,7 @@ hugo new [path] -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 ``` @@ -60,4 +59,4 @@ hugo new [path] * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) * [hugo new theme](/commands/hugo_new_theme/) - Create a new theme -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.030477738 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_new_site.md b/docs/content/commands/hugo_new_site.md index fbbb4e0f49e..2f6b091f4a2 100644 --- a/docs/content/commands/hugo_new_site.md +++ b/docs/content/commands/hugo_new_site.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ @@ -23,13 +23,12 @@ hugo new site [path] ``` -f, --format="toml": config & frontmatter format - -h, --help[=false]: help for site ``` ### 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/ @@ -46,7 +45,7 @@ hugo new site [path] -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 ``` @@ -54,4 +53,4 @@ hugo new site [path] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.030129171 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_new_theme.md b/docs/content/commands/hugo_new_theme.md index 04bd7c4a6ee..81a6b8f3493 100644 --- a/docs/content/commands/hugo_new_theme.md +++ b/docs/content/commands/hugo_new_theme.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ @@ -20,16 +20,10 @@ as you see fit. hugo new theme [name] ``` -### Options - -``` - -h, --help[=false]: help for theme -``` - ### 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/ @@ -46,7 +40,7 @@ hugo new theme [name] -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 ``` @@ -54,4 +48,4 @@ hugo new theme [name] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.030301827 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_server.md b/docs/content/commands/hugo_server.md index c61487ffb93..08eda82a1f9 100644 --- a/docs/content/commands/hugo_server.md +++ b/docs/content/commands/hugo_server.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ @@ -25,7 +25,6 @@ hugo server --appendPort[=true]: append port to baseurl --bind="127.0.0.1": interface to which the server will bind --disableLiveReload[=false]: watch without enabling live browser reload on rebuild - -h, --help[=false]: help for server --meminterval=100: interval to poll memory usage (requires --memstats) --memstats="": log memory usage to this file -p, --port=1313: port on which the server will listen @@ -35,7 +34,7 @@ hugo server ### 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/ @@ -52,7 +51,7 @@ hugo server -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 ``` @@ -60,4 +59,4 @@ hugo server ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.028196949 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_undraft.md b/docs/content/commands/hugo_undraft.md index ee460473dff..0e0cacf52cb 100644 --- a/docs/content/commands/hugo_undraft.md +++ b/docs/content/commands/hugo_undraft.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo undraft" slug: hugo_undraft url: /commands/hugo_undraft/ @@ -19,16 +19,10 @@ If the content's draft status is 'False', nothing is done. hugo undraft path/to/content ``` -### Options - -``` - -h, --help[=false]: help for undraft -``` - ### 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/ @@ -45,7 +39,7 @@ hugo undraft path/to/content -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 ``` @@ -53,4 +47,4 @@ hugo undraft path/to/content ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.031353807 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/commands/hugo_version.md b/docs/content/commands/hugo_version.md index 8eafdeaf44b..db51681a4f1 100644 --- a/docs/content/commands/hugo_version.md +++ b/docs/content/commands/hugo_version.md @@ -1,5 +1,5 @@ --- -date: 2015-08-04T03:11:10-06:00 +date: 2015-09-08T22:45:13-06:00 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ @@ -17,16 +17,10 @@ All software has versions. This is Hugo's. hugo version ``` -### Options - -``` - -h, --help[=false]: help for version -``` - ### 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/ @@ -43,7 +37,7 @@ hugo version -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 ``` @@ -51,4 +45,4 @@ hugo version ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra at 2015-08-04 09:11:10.028562395 +0000 UTC +###### Auto generated by spf13/cobra on 8-Sep-2015 diff --git a/docs/content/content/organization.md b/docs/content/content/organization.md index 3d917743544..4562aedd45b 100644 --- a/docs/content/content/organization.md +++ b/docs/content/content/organization.md @@ -36,7 +36,7 @@ in Hugo and is used as the [section](/content/sections/). ├── first.md // <- http://1.com/quote/first/ └── second.md // <- http://1.com/quote/second/ -**Here's the same organization run with `hugo --uglyUrls`** +**Here's the same organization run with `hugo --uglyURLs`** . └── content @@ -90,7 +90,7 @@ path. Includes [section](/content/sections/). A complete URL can be provided. This will override all the above as it pertains to the end destination. This must be the path from the baseURL (starting with a "/"). When a `url` is provided, it will be used exactly. Using `url` will ignore the -`--uglyUrls` setting. +`--uglyURLs` setting. ## Path breakdown in Hugo diff --git a/docs/content/extras/aliases.md b/docs/content/extras/aliases.md index 23af612e212..885abc967e5 100644 --- a/docs/content/extras/aliases.md +++ b/docs/content/extras/aliases.md @@ -55,7 +55,7 @@ Now when you visit any of the locations specified in aliases, _assuming the same ## Important Behaviors 1. *Hugo makes no assumptions about aliases. They also don't change based -on your UglyUrls setting. You need to provide absolute path to your webroot and the +on your UglyURLs setting. You need to provide absolute path to your webroot and the complete filename or directory.* 2. *Aliases are rendered prior to any content and will be overwritten by diff --git a/docs/content/extras/urls.md b/docs/content/extras/urls.md index ccbcdf225d7..0725a05b79c 100644 --- a/docs/content/extras/urls.md +++ b/docs/content/extras/urls.md @@ -24,7 +24,7 @@ If you would like to have what we call "ugly URLs", e.g. http://example.com/extras/urls.html, you are in luck. Hugo supports the ability to create your entire site with ugly URLs. Simply add `uglyurls = true` to your site-wide `config.toml`, -or use the `--uglyUrls=true` flag on the command line. +or use the `--uglyURLs=true` flag on the command line. If you want a specific piece of content to have an exact URL, you can specify this in the front matter under the `url` key. See [Content diff --git a/docs/content/overview/configuration.md b/docs/content/overview/configuration.md index af1851b67a2..c1a0686e11d 100644 --- a/docs/content/overview/configuration.md +++ b/docs/content/overview/configuration.md @@ -74,7 +74,7 @@ Following is a list of Hugo-defined variables that you can configure and their c --- archetypedir: "archetype" - # hostname (and path) to the root eg. http://spf13.com/ + # hostname (and path) to the root, e.g. http://spf13.com/ baseURL: "" # include content marked as draft buildDrafts: false diff --git a/docs/content/overview/usage.md b/docs/content/overview/usage.md index 29230208598..5f073e25825 100644 --- a/docs/content/overview/usage.md +++ b/docs/content/overview/usage.md @@ -37,7 +37,7 @@ Available Commands: help Help about any command Flags: - -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/ @@ -55,7 +55,7 @@ Flags: -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 @@ -173,7 +173,7 @@ No other web server software (Apache, nginx, IIS...) is necessary. Here is the command: hugo server --watch \ - --baseUrl=http://yoursite.org/ --port=80 \ + --baseURL=http://yoursite.org/ --port=80 \ --appendPort=false --bind=87.245.198.50