diff options
39 files changed, 510 insertions, 338 deletions
diff --git a/docs/README.md b/docs/README.md index 3fbfcf1ca..d82776de3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,6 +10,10 @@ Note that this repository contains solely the documentation for Hugo. For contri *Pull requests shall **only** contain changes to the actual documentation. However, changes on the code base of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.* +## Branches + +* The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version. +* The `next` branch is where we store changes that is related to the next Hugo release. This can be previewed here: https://next--gohugoio.netlify.com/ ## Build diff --git a/docs/config.toml b/docs/config.toml index 521ff9dee..e87a06e72 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -21,6 +21,11 @@ disableAliases = true # It is (currently) not in use, but you can do ```go in a content file if you want to. pygmentsCodeFences = true +pygmentsOptions = "" +# Use the Chroma stylesheet +pygmentsUseClasses = true +pygmentsUseClassic = false + # See https://help.farbox.com/pygments.html pygmentsStyle = "friendly" diff --git a/docs/content/commands/_index.md b/docs/content/commands/_index.md deleted file mode 100644 index 0bd5667f8..000000000 --- a/docs/content/commands/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Command Line Reference -linktitle: CLI Overview -description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -categories: [commands] -keywords: [cli,command line] -menu: - docs: - parent: "commands" - weight: 1 -weight: 01 #rem -draft: false -aliases: [/cli/] ---- - -The following list contains auto-generated and up-to-date (thanks to [Cobra][]) documentation for all the CLI commands in Hugo. - - -[Cobra]: https://github.com/spf13/cobra diff --git a/docs/content/commands/hugo.md b/docs/content/commands/hugo.md index 1246f78ca..1062291bf 100644 --- a/docs/content/commands/hugo.md +++ b/docs/content/commands/hugo.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo" slug: hugo url: /commands/hugo/ @@ -34,6 +34,7 @@ hugo [flags] --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 + --debug debug output -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.) @@ -77,4 +78,4 @@ hugo [flags] * [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 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_benchmark.md b/docs/content/commands/hugo_benchmark.md index 2a7f9f8f4..c05cc71b5 100644 --- a/docs/content/commands/hugo_benchmark.md +++ b/docs/content/commands/hugo_benchmark.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo benchmark" slug: hugo_benchmark url: /commands/hugo_benchmark/ @@ -59,6 +59,7 @@ hugo benchmark [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -69,4 +70,4 @@ hugo benchmark [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_check.md b/docs/content/commands/hugo_check.md index b7fb2c843..bfda906c1 100644 --- a/docs/content/commands/hugo_check.md +++ b/docs/content/commands/hugo_check.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo check" slug: hugo_check url: /commands/hugo_check/ @@ -23,6 +23,7 @@ Contains some verification checks ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -34,4 +35,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 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_check_ulimit.md b/docs/content/commands/hugo_check_ulimit.md index c98c85111..ac14c24ae 100644 --- a/docs/content/commands/hugo_check_ulimit.md +++ b/docs/content/commands/hugo_check_ulimit.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo check ulimit" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ @@ -28,6 +28,7 @@ hugo check ulimit [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -38,4 +39,4 @@ hugo check ulimit [flags] ### SEE ALSO * [hugo check](/commands/hugo_check/) - Contains some verification checks -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_config.md b/docs/content/commands/hugo_config.md index 0dd2052f5..abe089bd8 100644 --- a/docs/content/commands/hugo_config.md +++ b/docs/content/commands/hugo_config.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo config" slug: hugo_config url: /commands/hugo_config/ @@ -27,6 +27,7 @@ hugo config [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -37,4 +38,4 @@ hugo config [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_convert.md b/docs/content/commands/hugo_convert.md index 4202534ce..27a50bc3e 100644 --- a/docs/content/commands/hugo_convert.md +++ b/docs/content/commands/hugo_convert.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo convert" slug: hugo_convert url: /commands/hugo_convert/ @@ -28,6 +28,7 @@ See convert's subcommands toJSON, toTOML and toYAML for more information. ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -41,4 +42,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 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_convert_toJSON.md b/docs/content/commands/hugo_convert_toJSON.md index 36b1ffe2e..877be7477 100644 --- a/docs/content/commands/hugo_convert_toJSON.md +++ b/docs/content/commands/hugo_convert_toJSON.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ @@ -28,6 +28,7 @@ hugo convert toJSON [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to @@ -41,4 +42,4 @@ hugo convert toJSON [flags] ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_convert_toTOML.md b/docs/content/commands/hugo_convert_toTOML.md index 29c4f045e..e33e5d043 100644 --- a/docs/content/commands/hugo_convert_toTOML.md +++ b/docs/content/commands/hugo_convert_toTOML.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ @@ -28,6 +28,7 @@ hugo convert toTOML [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to @@ -41,4 +42,4 @@ hugo convert toTOML [flags] ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_convert_toYAML.md b/docs/content/commands/hugo_convert_toYAML.md index 37d305d32..a8667d2fa 100644 --- a/docs/content/commands/hugo_convert_toYAML.md +++ b/docs/content/commands/hugo_convert_toYAML.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ @@ -28,6 +28,7 @@ hugo convert toYAML [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to @@ -41,4 +42,4 @@ hugo convert toYAML [flags] ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_env.md b/docs/content/commands/hugo_env.md index 1d3b45127..649bee682 100644 --- a/docs/content/commands/hugo_env.md +++ b/docs/content/commands/hugo_env.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo env" slug: hugo_env url: /commands/hugo_env/ @@ -27,6 +27,7 @@ hugo env [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -37,4 +38,4 @@ hugo env [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_gen.md b/docs/content/commands/hugo_gen.md index 2aa9e228a..722275714 100644 --- a/docs/content/commands/hugo_gen.md +++ b/docs/content/commands/hugo_gen.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo gen" slug: hugo_gen url: /commands/hugo_gen/ @@ -23,6 +23,7 @@ A collection of several useful generators. ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -33,7 +34,8 @@ A collection of several useful generators. ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo +* [hugo gen chromastyles](/commands/hugo_gen_chromastyles/) - Generate CSS stylesheet for the Chroma code highlighter * [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 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_gen_autocomplete.md b/docs/content/commands/hugo_gen_autocomplete.md index 95002dae8..6e0674bf7 100644 --- a/docs/content/commands/hugo_gen_autocomplete.md +++ b/docs/content/commands/hugo_gen_autocomplete.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo gen autocomplete" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ @@ -45,6 +45,7 @@ hugo gen autocomplete [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -55,4 +56,4 @@ hugo gen autocomplete [flags] ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_gen_chromastyles.md b/docs/content/commands/hugo_gen_chromastyles.md new file mode 100644 index 000000000..a070a213a --- /dev/null +++ b/docs/content/commands/hugo_gen_chromastyles.md @@ -0,0 +1,46 @@ +--- +date: 2017-09-25T08:30:15+02:00 +title: "hugo gen chromastyles" +slug: hugo_gen_chromastyles +url: /commands/hugo_gen_chromastyles/ +--- +## hugo gen chromastyles + +Generate CSS stylesheet for the Chroma code highlighter + +### Synopsis + + +Generate CSS stylesheet for the Chroma code highlighter for a given style. This stylesheet is needed if pygmentsUseClasses is enabled in config. + +See https://help.farbox.com/pygments.html for preview of available styles + +``` +hugo gen chromastyles [flags] +``` + +### Options + +``` + -h, --help help for chromastyles + --highlightStyle string style used for highlighting lines (see https://github.com/alecthomas/chroma) (default "bg:#ffffcc") + --linesStyle string style used for line numbers (see https://github.com/alecthomas/chroma) + --style string highlighter style (see https://help.farbox.com/pygments.html) (default "friendly") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --debug debug output + --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 +``` + +### SEE ALSO +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. + +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_gen_doc.md b/docs/content/commands/hugo_gen_doc.md index e7dbd7ba3..b5daf3d9d 100644 --- a/docs/content/commands/hugo_gen_doc.md +++ b/docs/content/commands/hugo_gen_doc.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo gen doc" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ @@ -34,6 +34,7 @@ hugo gen doc [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -44,4 +45,4 @@ hugo gen doc [flags] ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_gen_man.md b/docs/content/commands/hugo_gen_man.md index 2e03d3714..52b062fc3 100644 --- a/docs/content/commands/hugo_gen_man.md +++ b/docs/content/commands/hugo_gen_man.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo gen man" slug: hugo_gen_man url: /commands/hugo_gen_man/ @@ -30,6 +30,7 @@ hugo gen man [flags] ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -40,4 +41,4 @@ hugo gen man [flags] ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_import.md b/docs/content/commands/hugo_import.md index c46b1d0b9..3af546640 100644 --- a/docs/content/commands/hugo_import.md +++ b/docs/content/commands/hugo_import.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo import" slug: hugo_import url: /commands/hugo_import/ @@ -25,6 +25,7 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p ``` --config string config file (default is path/config.yaml|json|toml) + --debug debug output --log enable Logging --logFile string log File path (if set, logging enabled automatically) --quiet build in quiet mode @@ -36,4 +37,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 16-Jul-2017 +###### Auto generated by spf13/cobra on 25-Sep-2017 diff --git a/docs/content/commands/hugo_import_jekyll.md b/docs/content/commands/hugo_import_jekyll.md index 5edf76e29..156ac79ec 100644 --- a/docs/content/commands/hugo_import_jekyll.md +++ b/docs/content/commands/hugo_import_jekyll.md @@ -1,5 +1,5 @@ --- -date: 2017-07-16T23:23:14+02:00 +date: 2017-09-25T08:30:15+02:00 title: "hugo import jekyll" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ @@ -30,6 +30,7 @@ hugo import jekyll [flags]< |