From f77a899ddd79dd379e122bfd7c310771af2f5cb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Wed, 25 Nov 2015 23:11:16 +0100 Subject: [PATCH] Regenerate the commands section of doc --- docs/content/commands/hugo.md | 11 ++-- docs/content/commands/hugo_benchmark.md | 5 +- docs/content/commands/hugo_check.md | 6 ++- docs/content/commands/hugo_check_ulimit.md | 50 ++++++++++++++++++ docs/content/commands/hugo_config.md | 5 +- docs/content/commands/hugo_convert.md | 5 +- docs/content/commands/hugo_convert_toJSON.md | 5 +- docs/content/commands/hugo_convert_toTOML.md | 5 +- docs/content/commands/hugo_convert_toYAML.md | 5 +- docs/content/commands/hugo_gen.md | 48 +++++++++++++++++ ...tocomplete.md => hugo_gen_autocomplete.md} | 17 ++++--- .../{hugo_gendoc.md => hugo_gen_doc.md} | 17 ++++--- docs/content/commands/hugo_gen_man.md | 51 +++++++++++++++++++ .../commands/{hugo_help.md => hugo_import.md} | 29 ++++------- docs/content/commands/hugo_import_jekyll.md | 51 +++++++++++++++++++ docs/content/commands/hugo_list.md | 5 +- docs/content/commands/hugo_list_drafts.md | 5 +- docs/content/commands/hugo_list_future.md | 5 +- docs/content/commands/hugo_new.md | 5 +- docs/content/commands/hugo_new_site.md | 6 ++- docs/content/commands/hugo_new_theme.md | 5 +- docs/content/commands/hugo_server.md | 26 +++++++--- docs/content/commands/hugo_undraft.md | 5 +- docs/content/commands/hugo_version.md | 5 +- 24 files changed, 301 insertions(+), 76 deletions(-) create mode 100644 docs/content/commands/hugo_check_ulimit.md create mode 100644 docs/content/commands/hugo_gen.md rename docs/content/commands/{hugo_genautocomplete.md => hugo_gen_autocomplete.md} (84%) rename docs/content/commands/{hugo_gendoc.md => hugo_gen_doc.md} (84%) create mode 100644 docs/content/commands/hugo_gen_man.md rename docs/content/commands/{hugo_help.md => hugo_import.md} (74%) create mode 100644 docs/content/commands/hugo_import_jekyll.md diff --git a/docs/content/commands/hugo.md b/docs/content/commands/hugo.md index 2a9231c0f..7ede1ab30 100644 --- a/docs/content/commands/hugo.md +++ b/docs/content/commands/hugo.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo" slug: hugo url: /commands/hugo/ @@ -29,6 +29,7 @@ hugo -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -54,12 +55,12 @@ hugo * [hugo check](/commands/hugo_check/) - Check content in the source directory * [hugo config](/commands/hugo_config/) - Print the site configuration * [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 gen](/commands/hugo_gen/) - A collection of several useful generators. +* [hugo import](/commands/hugo_import/) - Import your site from others. * [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 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 version](/commands/hugo_version/) - Print the version number of Hugo -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_benchmark.md b/docs/content/commands/hugo_benchmark.md index fbc59bce5..c500db2a5 100644 --- a/docs/content/commands/hugo_benchmark.md +++ b/docs/content/commands/hugo_benchmark.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo benchmark" slug: hugo_benchmark url: /commands/hugo_benchmark/ @@ -33,6 +33,7 @@ hugo benchmark -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -54,4 +55,4 @@ hugo benchmark ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_check.md b/docs/content/commands/hugo_check.md index b8f44d903..171a295cb 100644 --- a/docs/content/commands/hugo_check.md +++ b/docs/content/commands/hugo_check.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo check" slug: hugo_check url: /commands/hugo_check/ @@ -25,6 +25,7 @@ hugo check -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -45,5 +46,6 @@ hugo check ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site +* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_check_ulimit.md b/docs/content/commands/hugo_check_ulimit.md new file mode 100644 index 000000000..b34f8b13c --- /dev/null +++ b/docs/content/commands/hugo_check_ulimit.md @@ -0,0 +1,50 @@ +--- +date: 2015-11-25T23:10:39+01:00 +title: "hugo check ulimit" +slug: hugo_check_ulimit +url: /commands/hugo_check_ulimit/ +--- +## hugo check ulimit + +Check system ulimit settings + +### Synopsis + + +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 +``` + +### Options inherited from parent commands + +``` + -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL + --config="": config file (default is path/config.yaml|json|toml) + -d, --destination="": filesystem path to write files to + --disableRSS[=false]: Do not build RSS files + --disableSitemap[=false]: Do not build Sitemap file + --editor="": edit new content with this editor, if provided + --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) + --pluralizeListTitles[=true]: Pluralize titles in lists using inflect + --preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + -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/ + -v, --verbose[=false]: verbose output + --verboseLog[=false]: verbose logging +``` + +### SEE ALSO +* [hugo check](/commands/hugo_check/) - Check content in the source directory + +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_config.md b/docs/content/commands/hugo_config.md index f77b7665a..478e10d81 100644 --- a/docs/content/commands/hugo_config.md +++ b/docs/content/commands/hugo_config.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo config" slug: hugo_config url: /commands/hugo_config/ @@ -24,6 +24,7 @@ hugo config -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -45,4 +46,4 @@ hugo config ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_convert.md b/docs/content/commands/hugo_convert.md index 2e7315296..8e47056b7 100644 --- a/docs/content/commands/hugo_convert.md +++ b/docs/content/commands/hugo_convert.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo convert" slug: hugo_convert url: /commands/hugo_convert/ @@ -29,6 +29,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -53,4 +54,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 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_convert_toJSON.md b/docs/content/commands/hugo_convert_toJSON.md index 786a71924..92ded7ded 100644 --- a/docs/content/commands/hugo_convert_toJSON.md +++ b/docs/content/commands/hugo_convert_toJSON.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ @@ -25,6 +25,7 @@ hugo convert toJSON -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -48,4 +49,4 @@ hugo convert toJSON ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_convert_toTOML.md b/docs/content/commands/hugo_convert_toTOML.md index 0884d2470..7a666dcdb 100644 --- a/docs/content/commands/hugo_convert_toTOML.md +++ b/docs/content/commands/hugo_convert_toTOML.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ @@ -25,6 +25,7 @@ hugo convert toTOML -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -48,4 +49,4 @@ hugo convert toTOML ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_convert_toYAML.md b/docs/content/commands/hugo_convert_toYAML.md index e0e248b13..19f829116 100644 --- a/docs/content/commands/hugo_convert_toYAML.md +++ b/docs/content/commands/hugo_convert_toYAML.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ @@ -25,6 +25,7 @@ hugo convert toYAML -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -48,4 +49,4 @@ hugo convert toYAML ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_gen.md b/docs/content/commands/hugo_gen.md new file mode 100644 index 000000000..615ab9372 --- /dev/null +++ b/docs/content/commands/hugo_gen.md @@ -0,0 +1,48 @@ +--- +date: 2015-11-25T23:10:39+01:00 +title: "hugo gen" +slug: hugo_gen +url: /commands/hugo_gen/ +--- +## hugo gen + +A collection of several useful generators. + +### Synopsis + + +A collection of several useful generators. + +### Options inherited from parent commands + +``` + -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL + --config="": config file (default is path/config.yaml|json|toml) + -d, --destination="": filesystem path to write files to + --disableRSS[=false]: Do not build RSS files + --disableSitemap[=false]: Do not build Sitemap file + --editor="": edit new content with this editor, if provided + --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) + --pluralizeListTitles[=true]: Pluralize titles in lists using inflect + --preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + -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/ + -v, --verbose[=false]: verbose output + --verboseLog[=false]: verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo +* [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-Nov-2015 diff --git a/docs/content/commands/hugo_genautocomplete.md b/docs/content/commands/hugo_gen_autocomplete.md similarity index 84% rename from docs/content/commands/hugo_genautocomplete.md rename to docs/content/commands/hugo_gen_autocomplete.md index 18f00f91b..00ad8c557 100644 --- a/docs/content/commands/hugo_genautocomplete.md +++ b/docs/content/commands/hugo_gen_autocomplete.md @@ -1,10 +1,10 @@ --- -date: 2015-09-08T22:45:13-06:00 -title: "hugo genautocomplete" -slug: hugo_genautocomplete -url: /commands/hugo_genautocomplete/ +date: 2015-11-25T23:10:39+01:00 +title: "hugo gen autocomplete" +slug: hugo_gen_autocomplete +url: /commands/hugo_gen_autocomplete/ --- -## hugo genautocomplete +## hugo gen autocomplete Generate shell autocompletion script for Hugo @@ -30,7 +30,7 @@ or just source them in directly: $ . /etc/bash_completion ``` -hugo genautocomplete +hugo gen autocomplete ``` ### Options @@ -47,6 +47,7 @@ hugo genautocomplete -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -66,6 +67,6 @@ hugo genautocomplete ``` ### SEE ALSO -* [hugo](/commands/hugo/) - hugo builds your site +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_gendoc.md b/docs/content/commands/hugo_gen_doc.md similarity index 84% rename from docs/content/commands/hugo_gendoc.md rename to docs/content/commands/hugo_gen_doc.md index 8534ad556..7e35155ac 100644 --- a/docs/content/commands/hugo_gendoc.md +++ b/docs/content/commands/hugo_gen_doc.md @@ -1,10 +1,10 @@ --- -date: 2015-09-08T22:45:13-06:00 -title: "hugo gendoc" -slug: hugo_gendoc -url: /commands/hugo_gendoc/ +date: 2015-11-25T23:10:39+01:00 +title: "hugo gen doc" +slug: hugo_gen_doc +url: /commands/hugo_gen_doc/ --- -## hugo gendoc +## hugo gen doc Generate Markdown documentation for the Hugo CLI. @@ -20,7 +20,7 @@ It creates one Markdown file per command with front matter suitable for rendering in Hugo. ``` -hugo gendoc +hugo gen doc ``` ### Options @@ -36,6 +36,7 @@ hugo gendoc -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -55,6 +56,6 @@ hugo gendoc ``` ### SEE ALSO -* [hugo](/commands/hugo/) - hugo builds your site +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_gen_man.md b/docs/content/commands/hugo_gen_man.md new file mode 100644 index 000000000..77bd77e08 --- /dev/null +++ b/docs/content/commands/hugo_gen_man.md @@ -0,0 +1,51 @@ +--- +date: 2015-11-25T23:10:39+01:00 +title: "hugo gen man" +slug: hugo_gen_man +url: /commands/hugo_gen_man/ +--- +## hugo gen man + +Generate man pages for the Hugo CLI + +### Synopsis + + +This command automatically generates up-to-date man pages of Hugo's +command-line interface. By default, it creates the man page files +in the "man" directory under the current directory. + +``` +hugo gen man +``` + +### Options inherited from parent commands + +``` + -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL + --config="": config file (default is path/config.yaml|json|toml) + -d, --destination="": filesystem path to write files to + --disableRSS[=false]: Do not build RSS files + --disableSitemap[=false]: Do not build Sitemap file + --editor="": edit new content with this editor, if provided + --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) + --pluralizeListTitles[=true]: Pluralize titles in lists using inflect + --preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + -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/ + -v, --verbose[=false]: verbose output + --verboseLog[=false]: verbose logging +``` + +### SEE ALSO +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. + +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_help.md b/docs/content/commands/hugo_import.md similarity index 74% rename from docs/content/commands/hugo_help.md rename to docs/content/commands/hugo_import.md index 3ec4c8b81..7d6b8784b 100644 --- a/docs/content/commands/hugo_help.md +++ b/docs/content/commands/hugo_import.md @@ -1,28 +1,19 @@ --- -date: 2015-08-04T03:11:10-06:00 -title: "hugo help" -slug: hugo_help -url: /commands/hugo_help/ +date: 2015-11-25T23:10:39+01:00 +title: "hugo import" +slug: hugo_import +url: /commands/hugo_import/ --- -## hugo help +## hugo import -Help about any command +Import your site from others. ### Synopsis -Help provides help for any command in the application. - Simply type hugo help [path to command] for full details. +Import your site from other web site generators like Jekyll. -``` -hugo help [command] -``` - -### Options - -``` - -h, --help[=false]: help for help -``` +Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. ### Options inherited from parent commands @@ -31,6 +22,7 @@ hugo help [command] -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -51,5 +43,6 @@ hugo help [command] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site +* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_import_jekyll.md b/docs/content/commands/hugo_import_jekyll.md new file mode 100644 index 000000000..ace9f59e6 --- /dev/null +++ b/docs/content/commands/hugo_import_jekyll.md @@ -0,0 +1,51 @@ +--- +date: 2015-11-25T23:10:39+01:00 +title: "hugo import jekyll" +slug: hugo_import_jekyll +url: /commands/hugo_import_jekyll/ +--- +## hugo import jekyll + +hugo import from Jekyll + +### Synopsis + + +hugo import from Jekyll. + +Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. + +``` +hugo import jekyll +``` + +### Options inherited from parent commands + +``` + -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL + --config="": config file (default is path/config.yaml|json|toml) + -d, --destination="": filesystem path to write files to + --disableRSS[=false]: Do not build RSS files + --disableSitemap[=false]: Do not build Sitemap file + --editor="": edit new content with this editor, if provided + --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) + --pluralizeListTitles[=true]: Pluralize titles in lists using inflect + --preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + -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/ + -v, --verbose[=false]: verbose output + --verboseLog[=false]: verbose logging +``` + +### SEE ALSO +* [hugo import](/commands/hugo_import/) - Import your site from others. + +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_list.md b/docs/content/commands/hugo_list.md index 91388d35a..3abb19618 100644 --- a/docs/content/commands/hugo_list.md +++ b/docs/content/commands/hugo_list.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo list" slug: hugo_list url: /commands/hugo_list/ @@ -22,6 +22,7 @@ List requires a subcommand, e.g. `hugo list drafts`. -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -45,4 +46,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 on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_list_drafts.md b/docs/content/commands/hugo_list_drafts.md index 2bd8be527..615b6f85c 100644 --- a/docs/content/commands/hugo_list_drafts.md +++ b/docs/content/commands/hugo_list_drafts.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ @@ -24,6 +24,7 @@ hugo list drafts -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -45,4 +46,4 @@ hugo list drafts ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_list_future.md b/docs/content/commands/hugo_list_future.md index d7329808a..491705ec4 100644 --- a/docs/content/commands/hugo_list_future.md +++ b/docs/content/commands/hugo_list_future.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ @@ -25,6 +25,7 @@ hugo list future -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -46,4 +47,4 @@ hugo list future ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_new.md b/docs/content/commands/hugo_new.md index a0ede3659..09d17c11f 100644 --- a/docs/content/commands/hugo_new.md +++ b/docs/content/commands/hugo_new.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo new" slug: hugo_new url: /commands/hugo_new/ @@ -36,6 +36,7 @@ hugo new [path] -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -59,4 +60,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 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_new_site.md b/docs/content/commands/hugo_new_site.md index 2f6b091f4..20220c169 100644 --- a/docs/content/commands/hugo_new_site.md +++ b/docs/content/commands/hugo_new_site.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ @@ -22,6 +22,7 @@ hugo new site [path] ### Options ``` + --force[=false]: Init inside non-empty directory -f, --format="toml": config & frontmatter format ``` @@ -32,6 +33,7 @@ hugo new site [path] -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -53,4 +55,4 @@ hugo new site [path] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_new_theme.md b/docs/content/commands/hugo_new_theme.md index 81a6b8f34..204138028 100644 --- a/docs/content/commands/hugo_new_theme.md +++ b/docs/content/commands/hugo_new_theme.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ @@ -27,6 +27,7 @@ hugo new theme [name] -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -48,4 +49,4 @@ hugo new theme [name] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_server.md b/docs/content/commands/hugo_server.md index 08eda82a1..a80bf59d9 100644 --- a/docs/content/commands/hugo_server.md +++ b/docs/content/commands/hugo_server.md @@ -1,19 +1,28 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ --- ## hugo server -Hugo runs its own webserver to render the files +A high performance webserver ### Synopsis -Hugo is able to run its own high performance web server. -Hugo will render all the files defined in the source directory and -serve them up. +Hugo provides its own webserver which builds and serves the site. +While hugo server is high performance, it is a webserver with limited options. +Many run it in production, but the standard behavior is for people to use it +in development and use a more full featured server such as Nginx or Caddy. + +'hugo server' will avoid writing the rendered and served content to disk, +preferring to store it in memory. + +By default hugo will also watch your files for any changes you make and +automatically rebuild the site. It will then live reload any open browser pages +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 @@ -27,8 +36,10 @@ hugo server --disableLiveReload[=false]: watch without enabling live browser reload on rebuild --meminterval=100: interval to poll memory usage (requires --memstats) --memstats="": log memory usage to this file + --noTimes[=false]: Don't sync modification time of files -p, --port=1313: port on which the server will listen - -w, --watch[=false]: watch filesystem for changes and recreate as needed + --renderToDisk[=false]: render to Destination path (default is render to memory & serve from there) + -w, --watch[=true]: watch filesystem for changes and recreate as needed ``` ### Options inherited from parent commands @@ -38,6 +49,7 @@ hugo server -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -59,4 +71,4 @@ hugo server ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_undraft.md b/docs/content/commands/hugo_undraft.md index 0e0cacf52..510e80293 100644 --- a/docs/content/commands/hugo_undraft.md +++ b/docs/content/commands/hugo_undraft.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo undraft" slug: hugo_undraft url: /commands/hugo_undraft/ @@ -26,6 +26,7 @@ hugo undraft path/to/content -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -47,4 +48,4 @@ hugo undraft path/to/content ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015 diff --git a/docs/content/commands/hugo_version.md b/docs/content/commands/hugo_version.md index db51681a4..f3efd7f32 100644 --- a/docs/content/commands/hugo_version.md +++ b/docs/content/commands/hugo_version.md @@ -1,5 +1,5 @@ --- -date: 2015-09-08T22:45:13-06:00 +date: 2015-11-25T23:10:39+01:00 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ @@ -24,6 +24,7 @@ hugo version -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/ + --canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL --config="": config file (default is path/config.yaml|json|toml) -d, --destination="": filesystem path to write files to --disableRSS[=false]: Do not build RSS files @@ -45,4 +46,4 @@ hugo version ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 8-Sep-2015 +###### Auto generated by spf13/cobra on 25-Nov-2015