diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-03-26 20:46:01 +0300 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-03-26 20:46:01 +0300 |
commit | bb533ca5e1c778c95ed7014eab99c8cc1bd4c85e (patch) | |
tree | 9708411c1f7004e58e4a70d2625c2915f6e9a75f /docs | |
parent | 876e5f67b14a3707b757fd008bbcc7792057c69d (diff) |
docs: Regenerate CLI docs
Fixes #5779
Diffstat (limited to 'docs')
25 files changed, 57 insertions, 56 deletions
diff --git a/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index 70cb53c29..9ef8b3a04 100644 --- a/docs/content/en/commands/hugo.md +++ b/docs/content/en/commands/hugo.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo" slug: hugo url: /commands/hugo/ @@ -49,14 +49,15 @@ hugo [flags] --minify minify any supported output format (HTML, XML etc.) --noChmod don't sync permission mode of files --noTimes don't sync modification time of files + --path-warnings print warnings on duplicate target paths etc. --quiet build in quiet mode --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 --templateMetrics display metrics about template executions --templateMetricsHints calculate some improvement hints when combined with --templateMetrics -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory + --trace file write trace to file (not useful in general) -v, --verbose verbose output --verboseLog verbose logging -w, --watch watch filesystem for changes and recreate as needed @@ -75,4 +76,4 @@ hugo [flags] * [hugo server](/commands/hugo_server/) - A high performance webserver * [hugo version](/commands/hugo_version/) - Print the version number of Hugo -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_check.md b/docs/content/en/commands/hugo_check.md index 4e649fb56..d4b1d56e2 100644 --- a/docs/content/en/commands/hugo_check.md +++ b/docs/content/en/commands/hugo_check.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo check" slug: hugo_check url: /commands/hugo_check/ @@ -36,4 +36,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 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_check_ulimit.md b/docs/content/en/commands/hugo_check_ulimit.md index 185ef310f..c7be29efa 100644 --- a/docs/content/en/commands/hugo_check_ulimit.md +++ b/docs/content/en/commands/hugo_check_ulimit.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo check ulimit" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ @@ -40,4 +40,4 @@ hugo check ulimit [flags] * [hugo check](/commands/hugo_check/) - Contains some verification checks -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_config.md b/docs/content/en/commands/hugo_config.md index c488cc7e0..5236b5fac 100644 --- a/docs/content/en/commands/hugo_config.md +++ b/docs/content/en/commands/hugo_config.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo config" slug: hugo_config url: /commands/hugo_config/ @@ -40,4 +40,4 @@ hugo config [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_convert.md b/docs/content/en/commands/hugo_convert.md index f04338066..41d45dbb2 100644 --- a/docs/content/en/commands/hugo_convert.md +++ b/docs/content/en/commands/hugo_convert.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo convert" slug: hugo_convert url: /commands/hugo_convert/ @@ -10,12 +10,10 @@ Convert your content to different formats ### Synopsis -Convert your content files (front matter) to different formats. +Convert your content (e.g. front matter) to different formats. See convert's subcommands toJSON, toTOML and toYAML for more information. -**Please Note:** This will convert front matter only. It does not convert theme and configuration files (e.g. config.toml, theme.toml). Those files will need to be manually changed to your preference. - ### Options ``` @@ -45,4 +43,4 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. * [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML * [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_convert_toJSON.md b/docs/content/en/commands/hugo_convert_toJSON.md index a663177d7..7f613c822 100644 --- a/docs/content/en/commands/hugo_convert_toJSON.md +++ b/docs/content/en/commands/hugo_convert_toJSON.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ @@ -43,4 +43,4 @@ hugo convert toJSON [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_convert_toTOML.md b/docs/content/en/commands/hugo_convert_toTOML.md index 357376fcb..491c269f7 100644 --- a/docs/content/en/commands/hugo_convert_toTOML.md +++ b/docs/content/en/commands/hugo_convert_toTOML.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ @@ -43,4 +43,4 @@ hugo convert toTOML [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_convert_toYAML.md b/docs/content/en/commands/hugo_convert_toYAML.md index c5352a719..e5807853e 100644 --- a/docs/content/en/commands/hugo_convert_toYAML.md +++ b/docs/content/en/commands/hugo_convert_toYAML.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ @@ -43,4 +43,4 @@ hugo convert toYAML [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_env.md b/docs/content/en/commands/hugo_env.md index c801f1ae3..87ad8c4e7 100644 --- a/docs/content/en/commands/hugo_env.md +++ b/docs/content/en/commands/hugo_env.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo env" slug: hugo_env url: /commands/hugo_env/ @@ -39,4 +39,4 @@ hugo env [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_gen.md b/docs/content/en/commands/hugo_gen.md index 364187d47..511bb7b28 100644 --- a/docs/content/en/commands/hugo_gen.md +++ b/docs/content/en/commands/hugo_gen.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo gen" slug: hugo_gen url: /commands/hugo_gen/ @@ -39,4 +39,4 @@ A collection of several useful generators. * [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI. * [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_gen_autocomplete.md b/docs/content/en/commands/hugo_gen_autocomplete.md index 385b027c5..641d0238b 100644 --- a/docs/content/en/commands/hugo_gen_autocomplete.md +++ b/docs/content/en/commands/hugo_gen_autocomplete.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo gen autocomplete" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ @@ -57,4 +57,4 @@ hugo gen autocomplete [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_gen_chromastyles.md b/docs/content/en/commands/hugo_gen_chromastyles.md index b939b30f7..461860ac3 100644 --- a/docs/content/en/commands/hugo_gen_chromastyles.md +++ b/docs/content/en/commands/hugo_gen_chromastyles.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo gen chromastyles" slug: hugo_gen_chromastyles url: /commands/hugo_gen_chromastyles/ @@ -44,4 +44,4 @@ hugo gen chromastyles [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_gen_doc.md b/docs/content/en/commands/hugo_gen_doc.md index 8c8516850..7158ce9fd 100644 --- a/docs/content/en/commands/hugo_gen_doc.md +++ b/docs/content/en/commands/hugo_gen_doc.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo gen doc" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ @@ -46,4 +46,4 @@ hugo gen doc [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_gen_man.md b/docs/content/en/commands/hugo_gen_man.md index bbe87178a..45b1fcefe 100644 --- a/docs/content/en/commands/hugo_gen_man.md +++ b/docs/content/en/commands/hugo_gen_man.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo gen man" slug: hugo_gen_man url: /commands/hugo_gen_man/ @@ -42,4 +42,4 @@ hugo gen man [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_import.md b/docs/content/en/commands/hugo_import.md index 473431836..b12b7f714 100644 --- a/docs/content/en/commands/hugo_import.md +++ b/docs/content/en/commands/hugo_import.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo import" slug: hugo_import url: /commands/hugo_import/ @@ -38,4 +38,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 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_import_jekyll.md b/docs/content/en/commands/hugo_import_jekyll.md index f78fcd135..d794d119d 100644 --- a/docs/content/en/commands/hugo_import_jekyll.md +++ b/docs/content/en/commands/hugo_import_jekyll.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo import jekyll" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ @@ -42,4 +42,4 @@ hugo import jekyll [flags] * [hugo import](/commands/hugo_import/) - Import your site from others. -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_list.md b/docs/content/en/commands/hugo_list.md index de3cb7839..99caee1e8 100644 --- a/docs/content/en/commands/hugo_list.md +++ b/docs/content/en/commands/hugo_list.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo list" slug: hugo_list url: /commands/hugo_list/ @@ -41,4 +41,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 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_list_drafts.md b/docs/content/en/commands/hugo_list_drafts.md index aa65e787d..271a3ee5c 100644 --- a/docs/content/en/commands/hugo_list_drafts.md +++ b/docs/content/en/commands/hugo_list_drafts.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ @@ -40,4 +40,4 @@ hugo list drafts [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_list_expired.md b/docs/content/en/commands/hugo_list_expired.md index 106e41df2..df273ff73 100644 --- a/docs/content/en/commands/hugo_list_expired.md +++ b/docs/content/en/commands/hugo_list_expired.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo list expired" slug: hugo_list_expired url: /commands/hugo_list_expired/ @@ -41,4 +41,4 @@ hugo list expired [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_list_future.md b/docs/content/en/commands/hugo_list_future.md index 6e0c99857..4c559f2ba 100644 --- a/docs/content/en/commands/hugo_list_future.md +++ b/docs/content/en/commands/hugo_list_future.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ @@ -41,4 +41,4 @@ hugo list future [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_new.md b/docs/content/en/commands/hugo_new.md index cce7f4ecb..8b31e42fb 100644 --- a/docs/content/en/commands/hugo_new.md +++ b/docs/content/en/commands/hugo_new.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo new" slug: hugo_new url: /commands/hugo_new/ @@ -48,12 +48,13 @@ hugo new [path] [flags] --minify minify any supported output format (HTML, XML etc.) --noChmod don't sync permission mode of files --noTimes don't sync modification time of files + --path-warnings print warnings on duplicate target paths etc. -s, --source string filesystem path to read files relative from - --stepAnalysis display memory and timing of different steps of the program --templateMetrics display metrics about template executions --templateMetricsHints calculate some improvement hints when combined with --templateMetrics -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory + --trace file write trace to file (not useful in general) ``` ### Options inherited from parent commands @@ -75,4 +76,4 @@ hugo new [path] [flags] * [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 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_new_site.md b/docs/content/en/commands/hugo_new_site.md index 4bb9cda50..babe7127a 100644 --- a/docs/content/en/commands/hugo_new_site.md +++ b/docs/content/en/commands/hugo_new_site.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ @@ -44,4 +44,4 @@ hugo new site [path] [flags] * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_new_theme.md b/docs/content/en/commands/hugo_new_theme.md index a49301928..284b5cd3e 100644 --- a/docs/content/en/commands/hugo_new_theme.md +++ b/docs/content/en/commands/hugo_new_theme.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ @@ -43,4 +43,4 @@ hugo new theme [name] [flags] * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_server.md b/docs/content/en/commands/hugo_server.md index 501a5a99e..447482102 100644 --- a/docs/content/en/commands/hugo_server.md +++ b/docs/content/en/commands/hugo_server.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ @@ -60,14 +60,15 @@ hugo server [flags] --noChmod don't sync permission mode of files --noHTTPCache prevent HTTP caching --noTimes don't sync modification time of files + --path-warnings print warnings on duplicate target paths etc. -p, --port int port on which the server will listen (default 1313) --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 --templateMetrics display metrics about template executions --templateMetricsHints calculate some improvement hints when combined with --templateMetrics -t, --theme strings themes to use (located in /themes/THEMENAME/) --themesDir string filesystem path to themes directory + --trace file write trace to file (not useful in general) -w, --watch watch filesystem for changes and recreate as needed (default true) ``` @@ -88,4 +89,4 @@ hugo server [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 diff --git a/docs/content/en/commands/hugo_version.md b/docs/content/en/commands/hugo_version.md index 1b3d9080b..cdc014610 100644 --- a/docs/content/en/commands/hugo_version.md +++ b/docs/content/en/commands/hugo_version.md @@ -1,5 +1,5 @@ --- -date: 2019-01-30 +date: 2019-03-26 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ @@ -39,4 +39,4 @@ hugo version [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 30-Jan-2019 +###### Auto generated by spf13/cobra on 26-Mar-2019 |