phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-04 08:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Regenerate CLI docs

Browse source 
Fixes #5779
This commit is contained in:
Bjørn Erik Pedersen 2019-03-26 18:46:01 +01:00
parent 876e5f67b1
commit bb533ca5e1
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
25 changed files with 57 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/content/en/commands/hugo.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo" title: "hugo"
slug: hugo slug: hugo
url: /commands/hugo/ url: /commands/hugo/
@ -49,14 +49,15 @@ hugo [flags]
--minify minify any supported output format (HTML, XML etc.) --minify minify any supported output format (HTML, XML etc.)
--noChmod don't sync permission mode of files --noChmod don't sync permission mode of files
--noTimes don't sync modification time of files --noTimes don't sync modification time of files
--path-warnings print warnings on duplicate target paths etc.
--quiet build in quiet mode --quiet build in quiet mode
--renderToMemory render to memory (only useful for benchmark testing) --renderToMemory render to memory (only useful for benchmark testing)
-s, --source string filesystem path to read files relative from -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 --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general)
-v, --verbose verbose output -v, --verbose verbose output
--verboseLog verbose logging --verboseLog verbose logging
-w, --watch watch filesystem for changes and recreate as needed -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 server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo * [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

4
docs/content/en/commands/hugo_check.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo check" title: "hugo check"
slug: hugo_check slug: hugo_check
url: /commands/hugo_check/ url: /commands/hugo_check/
@ -36,4 +36,4 @@ Contains some verification checks
* [hugo](/commands/hugo/) - hugo builds your site * [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings * [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

4
docs/content/en/commands/hugo_check_ulimit.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo check ulimit" title: "hugo check ulimit"
slug: hugo_check_ulimit slug: hugo_check_ulimit
url: /commands/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 * [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

4
docs/content/en/commands/hugo_config.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo config" title: "hugo config"
slug: hugo_config slug: hugo_config
url: /commands/hugo_config/ url: /commands/hugo_config/
@ -40,4 +40,4 @@ hugo config [flags]
* [hugo](/commands/hugo/) - hugo builds your site * [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

8
docs/content/en/commands/hugo_convert.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo convert" title: "hugo convert"
slug: hugo_convert slug: hugo_convert
url: /commands/hugo_convert/ url: /commands/hugo_convert/
@ -10,12 +10,10 @@ Convert your content to different formats
### Synopsis ### 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. 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 ### 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 toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML * [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

4
docs/content/en/commands/hugo_convert_toJSON.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo convert toJSON" title: "hugo convert toJSON"
slug: hugo_convert_toJSON slug: hugo_convert_toJSON
url: /commands/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 * [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

4
docs/content/en/commands/hugo_convert_toTOML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo convert toTOML" title: "hugo convert toTOML"
slug: hugo_convert_toTOML slug: hugo_convert_toTOML
url: /commands/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 * [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

4
docs/content/en/commands/hugo_convert_toYAML.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo convert toYAML" title: "hugo convert toYAML"
slug: hugo_convert_toYAML slug: hugo_convert_toYAML
url: /commands/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 * [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

4
docs/content/en/commands/hugo_env.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo env" title: "hugo env"
slug: hugo_env slug: hugo_env
url: /commands/hugo_env/ url: /commands/hugo_env/
@ -39,4 +39,4 @@ hugo env [flags]
* [hugo](/commands/hugo/) - hugo builds your site * [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

4
docs/content/en/commands/hugo_gen.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo gen" title: "hugo gen"
slug: hugo_gen slug: hugo_gen
url: /commands/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 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 * [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

4
docs/content/en/commands/hugo_gen_autocomplete.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo gen autocomplete" title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete slug: hugo_gen_autocomplete
url: /commands/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. * [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

4
docs/content/en/commands/hugo_gen_chromastyles.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo gen chromastyles" title: "hugo gen chromastyles"
slug: hugo_gen_chromastyles slug: hugo_gen_chromastyles
url: /commands/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. * [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

4
docs/content/en/commands/hugo_gen_doc.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo gen doc" title: "hugo gen doc"
slug: hugo_gen_doc slug: hugo_gen_doc
url: /commands/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. * [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

4
docs/content/en/commands/hugo_gen_man.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo gen man" title: "hugo gen man"
slug: hugo_gen_man slug: hugo_gen_man
url: /commands/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. * [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

4
docs/content/en/commands/hugo_import.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo import" title: "hugo import"
slug: hugo_import slug: hugo_import
url: /commands/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](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll * [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

4
docs/content/en/commands/hugo_import_jekyll.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo import jekyll" title: "hugo import jekyll"
slug: hugo_import_jekyll slug: hugo_import_jekyll
url: /commands/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. * [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

4
docs/content/en/commands/hugo_list.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo list" title: "hugo list"
slug: hugo_list slug: hugo_list
url: /commands/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 expired](/commands/hugo_list_expired/) - List all posts already expired
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future * [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

4
docs/content/en/commands/hugo_list_drafts.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo list drafts" title: "hugo list drafts"
slug: hugo_list_drafts slug: hugo_list_drafts
url: /commands/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 * [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

4
docs/content/en/commands/hugo_list_expired.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo list expired" title: "hugo list expired"
slug: hugo_list_expired slug: hugo_list_expired
url: /commands/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 * [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

4
docs/content/en/commands/hugo_list_future.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo list future" title: "hugo list future"
slug: hugo_list_future slug: hugo_list_future
url: /commands/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 * [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

7
docs/content/en/commands/hugo_new.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo new" title: "hugo new"
slug: hugo_new slug: hugo_new
url: /commands/hugo_new/ url: /commands/hugo_new/
@ -48,12 +48,13 @@ hugo new [path] [flags]
--minify minify any supported output format (HTML, XML etc.) --minify minify any supported output format (HTML, XML etc.)
--noChmod don't sync permission mode of files --noChmod don't sync permission mode of files
--noTimes don't sync modification time 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 -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 --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory --themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general)
``` ```
### Options inherited from parent commands ### 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 site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme * [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

4
docs/content/en/commands/hugo_new_site.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo new site" title: "hugo new site"
slug: hugo_new_site slug: hugo_new_site
url: /commands/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 * [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

4
docs/content/en/commands/hugo_new_theme.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo new theme" title: "hugo new theme"
slug: hugo_new_theme slug: hugo_new_theme
url: /commands/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 * [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

7
docs/content/en/commands/hugo_server.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo server" title: "hugo server"
slug: hugo_server slug: hugo_server
url: /commands/hugo_server/ url: /commands/hugo_server/
@ -60,14 +60,15 @@ hugo server [flags]
--noChmod don't sync permission mode of files --noChmod don't sync permission mode of files
--noHTTPCache prevent HTTP caching --noHTTPCache prevent HTTP caching
--noTimes don't sync modification time of files --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) -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) --renderToDisk render to Destination path (default is render to memory & serve from there)
-s, --source string filesystem path to read files relative from -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 --templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics --templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/) -t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory --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) -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 * [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

4
docs/content/en/commands/hugo_version.md
View file

@ -1,5 +1,5 @@
--- ---
date: 2019-01-30 date: 2019-03-26
title: "hugo version" title: "hugo version"
slug: hugo_version slug: hugo_version
url: /commands/hugo_version/ url: /commands/hugo_version/
@ -39,4 +39,4 @@ hugo version [flags]
* [hugo](/commands/hugo/) - hugo builds your site * [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