From 4b0d339321888559bd681abc175203fe3a14b017 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Sun, 16 Jul 2017 23:23:22 +0200 Subject: [PATCH] Regenerate commands doc --- content/commands/hugo.md | 42 +++++++++++------------ content/commands/hugo_benchmark.md | 40 ++++++++++----------- content/commands/hugo_check.md | 17 +++++---- content/commands/hugo_check_ulimit.md | 19 +++++----- content/commands/hugo_config.md | 19 +++++----- content/commands/hugo_convert.md | 12 +++---- content/commands/hugo_convert_toJSON.md | 19 +++++----- content/commands/hugo_convert_toTOML.md | 19 +++++----- content/commands/hugo_convert_toYAML.md | 19 +++++----- content/commands/hugo_env.md | 19 +++++----- content/commands/hugo_gen.md | 17 +++++---- content/commands/hugo_gen_autocomplete.md | 18 +++++----- content/commands/hugo_gen_doc.md | 14 ++++---- content/commands/hugo_gen_man.md | 14 ++++---- content/commands/hugo_import.md | 17 +++++---- content/commands/hugo_import_jekyll.md | 16 ++++----- content/commands/hugo_list.md | 12 +++---- content/commands/hugo_list_drafts.md | 19 +++++----- content/commands/hugo_list_expired.md | 19 +++++----- content/commands/hugo_list_future.md | 19 +++++----- content/commands/hugo_new.md | 17 ++++----- content/commands/hugo_new_site.md | 16 ++++----- content/commands/hugo_new_theme.md | 19 +++++----- content/commands/hugo_server.md | 41 +++++++++++----------- content/commands/hugo_undraft.md | 23 +++++++------ content/commands/hugo_version.md | 19 +++++----- 26 files changed, 274 insertions(+), 251 deletions(-) diff --git a/content/commands/hugo.md b/content/commands/hugo.md index dba99db3e..1246f78ca 100644 --- a/content/commands/hugo.md +++ b/content/commands/hugo.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo" -menu: - docs: - parent: "commands" slug: hugo url: /commands/hugo/ --- @@ -22,7 +19,7 @@ built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io/. ``` -hugo +hugo [flags] ``` ### Options @@ -34,25 +31,26 @@ hugo -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL - --cleanDestinationDir Remove files from destination not found in static directories + --cleanDestinationDir remove files from destination not found in static directories --config string config file (default is path/config.yaml|json|toml) -c, --contentDir string filesystem path to content directory -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. - --i18n-warnings Print missing translations - --ignoreCache Ignores the cache directory + --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. + -h, --help help for hugo + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory -l, --layoutDir string filesystem path to layout directory - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) - --noChmod Don't sync permission mode of files - --noTimes Don't sync modification time of files - --pluralizeListTitles Pluralize titles in lists using inflect (default true) - --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --quiet build in quiet mode --renderToMemory render to memory (only useful for benchmark testing) -s, --source string filesystem path to read files relative from @@ -76,7 +74,7 @@ hugo * [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/) - A high performance webserver -* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False' +* [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 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_benchmark.md b/content/commands/hugo_benchmark.md index a46489a1e..2a7f9f8f4 100644 --- a/content/commands/hugo_benchmark.md +++ b/content/commands/hugo_benchmark.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo benchmark" -menu: - docs: - parent: "commands" slug: hugo_benchmark url: /commands/hugo_benchmark/ --- @@ -18,7 +15,7 @@ Hugo can build a site many times over and analyze the running process creating a benchmark. ``` -hugo benchmark +hugo benchmark [flags] ``` ### Options @@ -30,25 +27,26 @@ hugo benchmark -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL - --cleanDestinationDir Remove files from destination not found in static directories + --cleanDestinationDir remove files from destination not found in static directories -c, --contentDir string filesystem path to content directory -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. - --i18n-warnings Print missing translations - --ignoreCache Ignores the cache directory + --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. + -h, --help help for benchmark + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory -l, --layoutDir string filesystem path to layout directory --memprofile string path/filename for the memory profile file - --noChmod Don't sync permission mode of files - --noTimes Don't sync modification time of files - --pluralizeListTitles Pluralize titles in lists using inflect (default true) - --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --renderToMemory render to memory (only useful for benchmark testing) -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program @@ -61,8 +59,8 @@ hugo benchmark ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -71,4 +69,4 @@ hugo benchmark ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_check.md b/content/commands/hugo_check.md index b17d6b9cf..b7fb2c843 100644 --- a/content/commands/hugo_check.md +++ b/content/commands/hugo_check.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo check" -menu: - docs: - parent: "commands" slug: hugo_check url: /commands/hugo_check/ --- @@ -16,12 +13,18 @@ Contains some verification checks Contains some verification checks +### Options + +``` + -h, --help help for check +``` + ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -31,4 +34,4 @@ Contains some verification checks * [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-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_check_ulimit.md b/content/commands/hugo_check_ulimit.md index 5f2ba1f6f..c98c85111 100644 --- a/content/commands/hugo_check_ulimit.md +++ b/content/commands/hugo_check_ulimit.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo check ulimit" -menu: - docs: - parent: "commands" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ --- @@ -18,15 +15,21 @@ Hugo will inspect the current ulimit settings on the system. This is primarily to ensure that Hugo can watch enough files on some OSs ``` -hugo check ulimit +hugo check ulimit [flags] +``` + +### Options + +``` + -h, --help help for ulimit ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -35,4 +38,4 @@ hugo check ulimit ### SEE ALSO * [hugo check](/commands/hugo_check/) - Contains some verification checks -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_config.md b/content/commands/hugo_config.md index 67df49119..0dd2052f5 100644 --- a/content/commands/hugo_config.md +++ b/content/commands/hugo_config.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo config" -menu: - docs: - parent: "commands" slug: hugo_config url: /commands/hugo_config/ --- @@ -17,15 +14,21 @@ Print the site configuration Print the site configuration, both default and custom settings. ``` -hugo config +hugo config [flags] +``` + +### Options + +``` + -h, --help help for config ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -34,4 +37,4 @@ hugo config ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_convert.md b/content/commands/hugo_convert.md index 6172189cf..4202534ce 100644 --- a/content/commands/hugo_convert.md +++ b/content/commands/hugo_convert.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo convert" -menu: - docs: - parent: "commands" slug: hugo_convert url: /commands/hugo_convert/ --- @@ -21,6 +18,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. ### Options ``` + -h, --help help for convert -o, --output string filesystem path to write files to -s, --source string filesystem path to read files relative from --unsafe enable less safe operations, please backup first @@ -30,8 +28,8 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -43,4 +41,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-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_convert_toJSON.md b/content/commands/hugo_convert_toJSON.md index ddd217619..36b1ffe2e 100644 --- a/content/commands/hugo_convert_toJSON.md +++ b/content/commands/hugo_convert_toJSON.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo convert toJSON" -menu: - docs: - parent: "commands" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ --- @@ -18,15 +15,21 @@ toJSON converts all front matter in the content directory to use JSON for the front matter. ``` -hugo convert toJSON +hugo convert toJSON [flags] +``` + +### Options + +``` + -h, --help help for toJSON ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -38,4 +41,4 @@ hugo convert toJSON ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_convert_toTOML.md b/content/commands/hugo_convert_toTOML.md index 9a7e32c47..29c4f045e 100644 --- a/content/commands/hugo_convert_toTOML.md +++ b/content/commands/hugo_convert_toTOML.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo convert toTOML" -menu: - docs: - parent: "commands" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ --- @@ -18,15 +15,21 @@ toTOML converts all front matter in the content directory to use TOML for the front matter. ``` -hugo convert toTOML +hugo convert toTOML [flags] +``` + +### Options + +``` + -h, --help help for toTOML ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -38,4 +41,4 @@ hugo convert toTOML ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_convert_toYAML.md b/content/commands/hugo_convert_toYAML.md index f9698151d..37d305d32 100644 --- a/content/commands/hugo_convert_toYAML.md +++ b/content/commands/hugo_convert_toYAML.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo convert toYAML" -menu: - docs: - parent: "commands" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ --- @@ -18,15 +15,21 @@ toYAML converts all front matter in the content directory to use YAML for the front matter. ``` -hugo convert toYAML +hugo convert toYAML [flags] +``` + +### Options + +``` + -h, --help help for toYAML ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -38,4 +41,4 @@ hugo convert toYAML ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_env.md b/content/commands/hugo_env.md index c5947a65b..1d3b45127 100644 --- a/content/commands/hugo_env.md +++ b/content/commands/hugo_env.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo env" -menu: - docs: - parent: "commands" slug: hugo_env url: /commands/hugo_env/ --- @@ -17,15 +14,21 @@ Print Hugo version and environment info Print Hugo version and environment info. This is useful in Hugo bug reports. ``` -hugo env +hugo env [flags] +``` + +### Options + +``` + -h, --help help for env ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -34,4 +37,4 @@ hugo env ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_gen.md b/content/commands/hugo_gen.md index ebab309e8..2aa9e228a 100644 --- a/content/commands/hugo_gen.md +++ b/content/commands/hugo_gen.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo gen" -menu: - docs: - parent: "commands" slug: hugo_gen url: /commands/hugo_gen/ --- @@ -16,12 +13,18 @@ A collection of several useful generators. A collection of several useful generators. +### Options + +``` + -h, --help help for gen +``` + ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -33,4 +36,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-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_gen_autocomplete.md b/content/commands/hugo_gen_autocomplete.md index 015dbd03e..95002dae8 100644 --- a/content/commands/hugo_gen_autocomplete.md +++ b/content/commands/hugo_gen_autocomplete.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo gen autocomplete" -menu: - docs: - parent: "commands" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ --- @@ -33,22 +30,23 @@ or just source them in directly: $ . /etc/bash_completion ``` -hugo gen autocomplete +hugo gen autocomplete [flags] ``` ### Options ``` - --completionfile string Autocompletion file (default "/etc/bash_completion.d/hugo.sh") - --type string Autocompletion type (currently only bash supported) (default "bash") + --completionfile string autocompletion file (default "/etc/bash_completion.d/hugo.sh") + -h, --help help for autocomplete + --type string autocompletion type (currently only bash supported) (default "bash") ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -57,4 +55,4 @@ hugo gen autocomplete ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_gen_doc.md b/content/commands/hugo_gen_doc.md index 43d6183ea..e7dbd7ba3 100644 --- a/content/commands/hugo_gen_doc.md +++ b/content/commands/hugo_gen_doc.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo gen doc" -menu: - docs: - parent: "commands" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ --- @@ -23,21 +20,22 @@ It creates one Markdown file per command with front matter suitable for rendering in Hugo. ``` -hugo gen doc +hugo gen doc [flags] ``` ### Options ``` --dir string the directory to write the doc. (default "/tmp/hugodoc/") + -h, --help help for doc ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -46,4 +44,4 @@ hugo gen doc ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_gen_man.md b/content/commands/hugo_gen_man.md index f77d00562..2e03d3714 100644 --- a/content/commands/hugo_gen_man.md +++ b/content/commands/hugo_gen_man.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo gen man" -menu: - docs: - parent: "commands" slug: hugo_gen_man url: /commands/hugo_gen_man/ --- @@ -19,21 +16,22 @@ command-line interface. By default, it creates the man page files in the "man" directory under the current directory. ``` -hugo gen man +hugo gen man [flags] ``` ### Options ``` --dir string the directory to write the man pages. (default "man/") + -h, --help help for man ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -42,4 +40,4 @@ hugo gen man ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_import.md b/content/commands/hugo_import.md index 18618cc61..c46b1d0b9 100644 --- a/content/commands/hugo_import.md +++ b/content/commands/hugo_import.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo import" -menu: - docs: - parent: "commands" slug: hugo_import url: /commands/hugo_import/ --- @@ -18,12 +15,18 @@ Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. +### Options + +``` + -h, --help help for import +``` + ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -33,4 +36,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p * [hugo](/commands/hugo/) - hugo builds your site * [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_import_jekyll.md b/content/commands/hugo_import_jekyll.md index d1cb5c49f..5edf76e29 100644 --- a/content/commands/hugo_import_jekyll.md +++ b/content/commands/hugo_import_jekyll.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo import jekyll" -menu: - docs: - parent: "commands" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ --- @@ -19,21 +16,22 @@ hugo import from Jekyll. Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. ``` -hugo import jekyll +hugo import jekyll [flags] ``` ### Options ``` - --force Allow import into non-empty target directory + --force allow import into non-empty target directory + -h, --help help for jekyll ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -42,4 +40,4 @@ hugo import jekyll ### SEE ALSO * [hugo import](/commands/hugo_import/) - Import your site from others. -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_list.md b/content/commands/hugo_list.md index 63ad5f4f9..87d81bd15 100644 --- a/content/commands/hugo_list.md +++ b/content/commands/hugo_list.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo list" -menu: - docs: - parent: "commands" slug: hugo_list url: /commands/hugo_list/ --- @@ -21,6 +18,7 @@ List requires a subcommand, e.g. `hugo list drafts`. ### Options ``` + -h, --help help for list -s, --source string filesystem path to read files relative from ``` @@ -28,8 +26,8 @@ List requires a subcommand, e.g. `hugo list drafts`. ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -41,4 +39,4 @@ List requires a subcommand, e.g. `hugo list drafts`. * [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired * [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_list_drafts.md b/content/commands/hugo_list_drafts.md index 1010b2ada..92d9fbc0d 100644 --- a/content/commands/hugo_list_drafts.md +++ b/content/commands/hugo_list_drafts.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo list drafts" -menu: - docs: - parent: "commands" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ --- @@ -17,15 +14,21 @@ List all drafts List all of the drafts in your content directory. ``` -hugo list drafts +hugo list drafts [flags] +``` + +### Options + +``` + -h, --help help for drafts ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode -s, --source string filesystem path to read files relative from -v, --verbose verbose output @@ -35,4 +38,4 @@ hugo list drafts ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_list_expired.md b/content/commands/hugo_list_expired.md index ec493ace9..697ffe83d 100644 --- a/content/commands/hugo_list_expired.md +++ b/content/commands/hugo_list_expired.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo list expired" -menu: - docs: - parent: "commands" slug: hugo_list_expired url: /commands/hugo_list_expired/ --- @@ -18,15 +15,21 @@ List all of the posts in your content directory which has already expired. ``` -hugo list expired +hugo list expired [flags] +``` + +### Options + +``` + -h, --help help for expired ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode -s, --source string filesystem path to read files relative from -v, --verbose verbose output @@ -36,4 +39,4 @@ hugo list expired ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_list_future.md b/content/commands/hugo_list_future.md index 4f8460182..51b6089d1 100644 --- a/content/commands/hugo_list_future.md +++ b/content/commands/hugo_list_future.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo list future" -menu: - docs: - parent: "commands" slug: hugo_list_future url: /commands/hugo_list_future/ --- @@ -18,15 +15,21 @@ List all of the posts in your content directory which will be posted in the future. ``` -hugo list future +hugo list future [flags] +``` + +### Options + +``` + -h, --help help for future ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode -s, --source string filesystem path to read files relative from -v, --verbose verbose output @@ -36,4 +39,4 @@ hugo list future ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_new.md b/content/commands/hugo_new.md index 1a98dbc45..fa4eab688 100644 --- a/content/commands/hugo_new.md +++ b/content/commands/hugo_new.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo new" -menu: - docs: - parent: "commands" slug: hugo_new url: /commands/hugo_new/ --- @@ -22,15 +19,15 @@ You can also specify the kind with `-k KIND`. If archetypes are provided in your theme or site, they will be used. ``` -hugo new [path] +hugo new [path] [flags] ``` ### Options ``` --editor string edit new content with this editor, if provided - -f, --format string frontmatter format (default "toml") - -k, --kind string Content type to create + -h, --help help for new + -k, --kind string content type to create -s, --source string filesystem path to read files relative from ``` @@ -38,8 +35,8 @@ hugo new [path] ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -50,4 +47,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 on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_new_site.md b/content/commands/hugo_new_site.md index cea69c8ae..3accfbbea 100644 --- a/content/commands/hugo_new_site.md +++ b/content/commands/hugo_new_site.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo new site" -menu: - docs: - parent: "commands" slug: hugo_new_site url: /commands/hugo_new_site/ --- @@ -19,22 +16,23 @@ The new site will have the correct structure, but no content or theme yet. Use `hugo new [contentPath]` to create new content. ``` -hugo new site [path] +hugo new site [path] [flags] ``` ### Options ``` - --force Init inside non-empty directory + --force init inside non-empty directory -f, --format string config & frontmatter format (default "toml") + -h, --help help for site ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode -s, --source string filesystem path to read files relative from -v, --verbose verbose output @@ -44,4 +42,4 @@ hugo new site [path] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_new_theme.md b/content/commands/hugo_new_theme.md index 41a014118..928d11b56 100644 --- a/content/commands/hugo_new_theme.md +++ b/content/commands/hugo_new_theme.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo new theme" -menu: - docs: - parent: "commands" slug: hugo_new_theme url: /commands/hugo_new_theme/ --- @@ -20,15 +17,21 @@ name to the copyright line in the license and adjust the theme.toml file as you see fit. ``` -hugo new theme [name] +hugo new theme [name] [flags] +``` + +### Options + +``` + -h, --help help for theme ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode -s, --source string filesystem path to read files relative from -v, --verbose verbose output @@ -38,4 +41,4 @@ hugo new theme [name] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_server.md b/content/commands/hugo_server.md index a243a7d24..5b58a52f0 100644 --- a/content/commands/hugo_server.md +++ b/content/commands/hugo_server.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo server" -menu: - docs: - parent: "commands" slug: hugo_server url: /commands/hugo_server/ --- @@ -28,7 +25,7 @@ and push the latest content to them. As most Hugo sites are built in a fraction of a second, you will be able to save and see your changes nearly instantly. ``` -hugo server +hugo server [flags] ``` ### Options @@ -42,26 +39,28 @@ hugo server -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL - --cleanDestinationDir Remove files from destination not found in static directories + --cleanDestinationDir remove files from destination not found in static directories -c, --contentDir string filesystem path to content directory -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.) + --disable404 do not render 404 page + --disableKinds stringSlice disable different kind of pages (home, RSS etc.) --disableLiveReload watch without enabling live browser reload on rebuild - --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. - --i18n-warnings Print missing translations - --ignoreCache Ignores the cache directory + --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. + -h, --help help for server + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory -l, --layoutDir string filesystem path to layout directory --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") --memstats string log memory usage to this file - --noChmod Don't sync permission mode of files - --noTimes Don't sync modification time of files - --pluralizeListTitles Pluralize titles in lists using inflect (default true) + --navigateToChanged navigate to changed content file on live browser reload + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) -p, --port int port on which the server will listen (default 1313) - --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --renderToDisk render to Destination path (default is render to memory & serve from there) -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program @@ -75,8 +74,8 @@ hugo server ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -85,4 +84,4 @@ hugo server ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_undraft.md b/content/commands/hugo_undraft.md index 1cdf93f69..bb408b80b 100644 --- a/content/commands/hugo_undraft.md +++ b/content/commands/hugo_undraft.md @@ -1,33 +1,36 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo undraft" -menu: - docs: - parent: "commands" slug: hugo_undraft url: /commands/hugo_undraft/ --- ## hugo undraft -Undraft changes the content's draft status from 'True' to 'False' +Undraft resets the content's draft status ### Synopsis -Undraft changes the content's draft status from 'True' to 'False' +Undraft resets the content's draft status and updates the date to the current date and time. If the content's draft status is 'False', nothing is done. ``` -hugo undraft path/to/content +hugo undraft path/to/content [flags] +``` + +### Options + +``` + -h, --help help for undraft ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -36,4 +39,4 @@ hugo undraft path/to/content ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017 diff --git a/content/commands/hugo_version.md b/content/commands/hugo_version.md index a2d82f888..522ff1008 100644 --- a/content/commands/hugo_version.md +++ b/content/commands/hugo_version.md @@ -1,9 +1,6 @@ --- -date: 2017-02-25T10:01:37+01:00 +date: 2017-07-16T23:23:14+02:00 title: "hugo version" -menu: - docs: - parent: "commands" slug: hugo_version url: /commands/hugo_version/ --- @@ -17,15 +14,21 @@ Print the version number of Hugo All software has versions. This is Hugo's. ``` -hugo version +hugo version [flags] +``` + +### Options + +``` + -h, --help help for version ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) - --log Enable Logging - --logFile string Log File path (if set, logging enabled automatically) + --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 @@ -34,4 +37,4 @@ hugo version ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 25-Feb-2017 +###### Auto generated by spf13/cobra on 16-Jul-2017