From ecf5e081b5540e69f4af330233f39a07baf53846 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Sun, 15 Oct 2017 10:20:55 +0200 Subject: [PATCH] Squashed 'docs/' changes from 000ab7c42..4628b9ec2 4628b9ec2 commands: Regen CLI doc 2525f2ed0 data: Regenerate docs helper 6f5a0eb19 Add Hugo 0.30 poster image 72c3fac9e Merge branch 'chroma-next2' into next 364973d3f Fix typo in syntax highlighting. ce10cc02e Update Chroma highlighting docs 9dcc4d4dd Update robots.md 1e64cb483 Rename title of cross references' page d6dfbbc51 Add warning about MMark and TOCs e8d259d32 Fix link to subsection in page 6adead19d Merge commit '040d8d2833c26c53cf9f0e035910821ed50e3863' 040d8d283 Squashed 'themes/gohugoioTheme/' changes from cdaa89c8..6b632895 bde95d890 Add Atlas starter kit fc40d078d Remove page arg from examples of relref shortcode c578620b5 Remove page arg from examples of ref shortcode ee81931a4 Remove delimiters in YAML and TOML config examples 62d7b269f Clarify that .Lastmod automatically uses .GitInfo.AuthorDate (#226) git-subtree-dir: docs git-subtree-split: 4628b9ec2c52df4de673a4d6b9621a65d8e8f5a4 --- content/commands/hugo.md | 82 +- content/commands/hugo_benchmark.md | 71 +- content/commands/hugo_check.md | 4 +- content/commands/hugo_check_ulimit.md | 4 +- content/commands/hugo_config.md | 4 +- content/commands/hugo_convert.md | 4 +- content/commands/hugo_convert_toJSON.md | 4 +- content/commands/hugo_convert_toTOML.md | 4 +- content/commands/hugo_convert_toYAML.md | 4 +- content/commands/hugo_env.md | 4 +- content/commands/hugo_gen.md | 4 +- content/commands/hugo_gen_autocomplete.md | 4 +- content/commands/hugo_gen_chromastyles.md | 4 +- content/commands/hugo_gen_doc.md | 4 +- content/commands/hugo_gen_man.md | 4 +- content/commands/hugo_import.md | 4 +- content/commands/hugo_import_jekyll.md | 4 +- content/commands/hugo_list.md | 4 +- content/commands/hugo_list_drafts.md | 4 +- content/commands/hugo_list_expired.md | 4 +- content/commands/hugo_list_future.md | 4 +- content/commands/hugo_new.md | 4 +- content/commands/hugo_new_site.md | 4 +- content/commands/hugo_new_theme.md | 4 +- content/commands/hugo_server.md | 86 +- content/commands/hugo_undraft.md | 4 +- content/commands/hugo_version.md | 4 +- .../content-management/cross-references.md | 2 +- content/content-management/menus.md | 2 +- .../content-management/syntax-highlighting.md | 8 +- content/content-management/toc.md | 4 + content/functions/ref.md | 6 +- content/functions/relref.md | 6 +- content/getting-started/configuration.md | 19 +- content/templates/robots.md | 4 +- content/tools/starter-kits.md | 4 +- content/variables/git.md | 4 + content/variables/page.md | 9 +- data/docs.json | 105 +- static/images/blog/hugo-30-poster.png | Bin 0 -> 123192 bytes .../layouts/_default/baseof.html | 2 +- .../layouts/partials/site-nav.html | 2 +- themes/gohugoioTheme/src/css/_chroma2.css | 3 + themes/gohugoioTheme/src/css/_code.css | 11 + .../gohugoioTheme/static/dist/app.bundle.js | 11696 +++++++++++++++- themes/gohugoioTheme/static/dist/main.css | 2 +- 46 files changed, 12024 insertions(+), 200 deletions(-) create mode 100644 static/images/blog/hugo-30-poster.png diff --git a/content/commands/hugo.md b/content/commands/hugo.md index 5521ee968d7..a3a5cedf99e 100644 --- a/content/commands/hugo.md +++ b/content/commands/hugo.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T17:09:31-05:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo" slug: hugo url: /commands/hugo/ @@ -25,48 +25,50 @@ hugo [flags] ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --canonifyURLs if true, all relative URLs will be canonicalized using baseURL - --cleanDestinationDir remove files from destination not found in static directories - --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.) - --disableRSS do not build RSS files - --disableSitemap do not build Sitemap file - --enableGitInfo add Git revision, date and author info to the pages - --forceSyncStatic copy all files when static is changed. - -h, --help help for hugo - --i18n-warnings print missing translations - --ignoreCache ignores the cache directory - -l, --layoutDir string filesystem path to layout directory - --log enable Logging - --logFile string log File path (if set, logging enabled automatically) - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --pluralizeListTitles pluralize titles in lists using inflect (default true) - --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") - --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 - -t, --theme string theme to use (located in /themes/THEMENAME/) - --themesDir string filesystem path to themes directory - --uglyURLs if true, use /filename.html instead of /filename/ - -v, --verbose verbose output - --verboseLog verbose logging - -w, --watch watch filesystem for changes and recreate as needed + -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --canonifyURLs if true, all relative URLs will be canonicalized using baseURL + --cleanDestinationDir remove files from destination not found in static directories + --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 strings disable different kind of pages (home, RSS etc.) + --disableRSS do not build RSS files + --disableSitemap do not build Sitemap file + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + -h, --help help for hugo + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --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 string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + --uglyURLs if true, use /filename.html instead of /filename/ + -v, --verbose verbose output + --verboseLog verbose logging + -w, --watch watch filesystem for changes and recreate as needed ``` ### SEE ALSO * [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times. +* [hugo check](/commands/hugo_check/) - Contains some verification checks * [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo env](/commands/hugo_env/) - Print Hugo version and environment info @@ -78,4 +80,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_benchmark.md b/content/commands/hugo_benchmark.md index dbf7bee1edc..8ffa1cf9b73 100644 --- a/content/commands/hugo_benchmark.md +++ b/content/commands/hugo_benchmark.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo benchmark" slug: hugo_benchmark url: /commands/hugo_benchmark/ @@ -21,39 +21,40 @@ hugo benchmark [flags] ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --canonifyURLs if true, all relative URLs will be canonicalized using baseURL - --cleanDestinationDir remove files from destination not found in static directories - -c, --contentDir string filesystem path to content directory - -n, --count int number of times to build the site (default 13) - --cpuprofile string path/filename for the CPU profile file - -d, --destination string filesystem path to write files to - --disable404 do not render 404 page - --disableKinds stringSlice disable different kind of pages (home, RSS etc.) - --disableRSS do not build RSS files - --disableSitemap do not build Sitemap file - --enableGitInfo add Git revision, date and author info to the pages - --forceSyncStatic copy all files when static is changed. - -h, --help help for benchmark - --i18n-warnings print missing translations - --ignoreCache ignores the cache directory - -l, --layoutDir string filesystem path to layout directory - --memprofile string path/filename for the memory profile file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --pluralizeListTitles pluralize titles in lists using inflect (default true) - --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") - --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 - -t, --theme string theme to use (located in /themes/THEMENAME/) - --themesDir string filesystem path to themes directory - --uglyURLs if true, use /filename.html instead of /filename/ + -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --canonifyURLs if true, all relative URLs will be canonicalized using baseURL + --cleanDestinationDir remove files from destination not found in static directories + -c, --contentDir string filesystem path to content directory + -n, --count int number of times to build the site (default 13) + --cpuprofile string path/filename for the CPU profile file + -d, --destination string filesystem path to write files to + --disable404 do not render 404 page + --disableKinds strings disable different kind of pages (home, RSS etc.) + --disableRSS do not build RSS files + --disableSitemap do not build Sitemap file + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + -h, --help help for benchmark + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --memprofile string path/filename for the memory profile file + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --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 string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + --uglyURLs if true, use /filename.html instead of /filename/ ``` ### Options inherited from parent commands @@ -71,4 +72,4 @@ hugo benchmark [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_check.md b/content/commands/hugo_check.md index 2c00589ecc5..f732588f95d 100644 --- a/content/commands/hugo_check.md +++ b/content/commands/hugo_check.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo check" slug: hugo_check url: /commands/hugo_check/ @@ -35,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_check_ulimit.md b/content/commands/hugo_check_ulimit.md index 15cdc0b2aa4..053618b04fc 100644 --- a/content/commands/hugo_check_ulimit.md +++ b/content/commands/hugo_check_ulimit.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo check ulimit" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ @@ -39,4 +39,4 @@ hugo check ulimit [flags] ### SEE ALSO * [hugo check](/commands/hugo_check/) - Contains some verification checks -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_config.md b/content/commands/hugo_config.md index 431f9150b9c..39ca0a8be34 100644 --- a/content/commands/hugo_config.md +++ b/content/commands/hugo_config.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo config" slug: hugo_config url: /commands/hugo_config/ @@ -38,4 +38,4 @@ hugo config [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_convert.md b/content/commands/hugo_convert.md index 491ece860ae..775e37c9475 100644 --- a/content/commands/hugo_convert.md +++ b/content/commands/hugo_convert.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo convert" slug: hugo_convert url: /commands/hugo_convert/ @@ -42,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_convert_toJSON.md b/content/commands/hugo_convert_toJSON.md index 7c27a638506..6f53030de0a 100644 --- a/content/commands/hugo_convert_toJSON.md +++ b/content/commands/hugo_convert_toJSON.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ @@ -42,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_convert_toTOML.md b/content/commands/hugo_convert_toTOML.md index 35a6d80b77a..2e91e7173fb 100644 --- a/content/commands/hugo_convert_toTOML.md +++ b/content/commands/hugo_convert_toTOML.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ @@ -42,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_convert_toYAML.md b/content/commands/hugo_convert_toYAML.md index 968a0e0b21a..ed0520f08ea 100644 --- a/content/commands/hugo_convert_toYAML.md +++ b/content/commands/hugo_convert_toYAML.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ @@ -42,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_env.md b/content/commands/hugo_env.md index aa90ae681c8..3bc5041af10 100644 --- a/content/commands/hugo_env.md +++ b/content/commands/hugo_env.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo env" slug: hugo_env url: /commands/hugo_env/ @@ -38,4 +38,4 @@ hugo env [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_gen.md b/content/commands/hugo_gen.md index bbb23fec99c..c82aeac4cc5 100644 --- a/content/commands/hugo_gen.md +++ b/content/commands/hugo_gen.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo gen" slug: hugo_gen url: /commands/hugo_gen/ @@ -38,4 +38,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_gen_autocomplete.md b/content/commands/hugo_gen_autocomplete.md index d42d28bbc16..e66642916a9 100644 --- a/content/commands/hugo_gen_autocomplete.md +++ b/content/commands/hugo_gen_autocomplete.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo gen autocomplete" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ @@ -56,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_gen_chromastyles.md b/content/commands/hugo_gen_chromastyles.md index 0e0843d7215..7b70cd4830e 100644 --- a/content/commands/hugo_gen_chromastyles.md +++ b/content/commands/hugo_gen_chromastyles.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo gen chromastyles" slug: hugo_gen_chromastyles url: /commands/hugo_gen_chromastyles/ @@ -43,4 +43,4 @@ hugo gen chromastyles [flags] ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_gen_doc.md b/content/commands/hugo_gen_doc.md index c614f135cdb..a368bc2c16a 100644 --- a/content/commands/hugo_gen_doc.md +++ b/content/commands/hugo_gen_doc.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo gen doc" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ @@ -45,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_gen_man.md b/content/commands/hugo_gen_man.md index a75123acf75..c4f45f33673 100644 --- a/content/commands/hugo_gen_man.md +++ b/content/commands/hugo_gen_man.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo gen man" slug: hugo_gen_man url: /commands/hugo_gen_man/ @@ -41,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_import.md b/content/commands/hugo_import.md index d4d61c166ec..585945263eb 100644 --- a/content/commands/hugo_import.md +++ b/content/commands/hugo_import.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo import" slug: hugo_import url: /commands/hugo_import/ @@ -37,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_import_jekyll.md b/content/commands/hugo_import_jekyll.md index 7c30f8cc603..65dc9a5eab7 100644 --- a/content/commands/hugo_import_jekyll.md +++ b/content/commands/hugo_import_jekyll.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo import jekyll" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ @@ -41,4 +41,4 @@ hugo import jekyll [flags] ### SEE ALSO * [hugo import](/commands/hugo_import/) - Import your site from others. -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_list.md b/content/commands/hugo_list.md index 962c0f0ab4b..07423aba967 100644 --- a/content/commands/hugo_list.md +++ b/content/commands/hugo_list.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo list" slug: hugo_list url: /commands/hugo_list/ @@ -40,4 +40,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_list_drafts.md b/content/commands/hugo_list_drafts.md index 080be07f33d..853736a35d6 100644 --- a/content/commands/hugo_list_drafts.md +++ b/content/commands/hugo_list_drafts.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ @@ -39,4 +39,4 @@ hugo list drafts [flags] ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_list_expired.md b/content/commands/hugo_list_expired.md index 7dfb007137f..8de9c7a15d1 100644 --- a/content/commands/hugo_list_expired.md +++ b/content/commands/hugo_list_expired.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo list expired" slug: hugo_list_expired url: /commands/hugo_list_expired/ @@ -40,4 +40,4 @@ hugo list expired [flags] ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_list_future.md b/content/commands/hugo_list_future.md index f0e884245c1..243199057db 100644 --- a/content/commands/hugo_list_future.md +++ b/content/commands/hugo_list_future.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ @@ -40,4 +40,4 @@ hugo list future [flags] ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_new.md b/content/commands/hugo_new.md index aae5ff77a28..6b4f927db9d 100644 --- a/content/commands/hugo_new.md +++ b/content/commands/hugo_new.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo new" slug: hugo_new url: /commands/hugo_new/ @@ -48,4 +48,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 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_new_site.md b/content/commands/hugo_new_site.md index a0ce812a367..4a812179d5e 100644 --- a/content/commands/hugo_new_site.md +++ b/content/commands/hugo_new_site.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ @@ -43,4 +43,4 @@ hugo new site [path] [flags] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_new_theme.md b/content/commands/hugo_new_theme.md index 79b729f64b4..e8718e98af0 100644 --- a/content/commands/hugo_new_theme.md +++ b/content/commands/hugo_new_theme.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ @@ -42,4 +42,4 @@ hugo new theme [name] [flags] ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_server.md b/content/commands/hugo_server.md index 87ccd9465ea..6d722e8aacc 100644 --- a/content/commands/hugo_server.md +++ b/content/commands/hugo_server.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ @@ -31,46 +31,48 @@ hugo server [flags] ### Options ``` - --appendPort append port to baseURL (default true) - -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ - --bind string interface to which the server will bind (default "127.0.0.1") - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --canonifyURLs if true, all relative URLs will be canonicalized using baseURL - --cleanDestinationDir remove files from destination not found in static directories - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disable404 do not render 404 page - --disableKinds stringSlice disable different kind of pages (home, RSS etc.) - --disableLiveReload watch without enabling live browser reload on rebuild - --disableRSS do not build RSS files - --disableSitemap do not build Sitemap file - --enableGitInfo add Git revision, date and author info to the pages - --forceSyncStatic copy all files when static is changed. - -h, --help help for server - --i18n-warnings print missing translations - --ignoreCache ignores the cache directory - -l, --layoutDir string filesystem path to layout directory - --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) - --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") - --memstats string log memory usage to this file - --navigateToChanged navigate to changed content file on live browser reload - --noChmod don't sync permission mode of files - --noHTTPCache prevent HTTP caching - --noTimes don't sync modification time of files - --pluralizeListTitles pluralize titles in lists using inflect (default true) - -p, --port int port on which the server will listen (default 1313) - --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") - --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 - -t, --theme string theme to use (located in /themes/THEMENAME/) - --themesDir string filesystem path to themes directory - --uglyURLs if true, use /filename.html instead of /filename/ - -w, --watch watch filesystem for changes and recreate as needed (default true) + --appendPort append port to baseURL (default true) + -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ + --bind string interface to which the server will bind (default "127.0.0.1") + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --canonifyURLs if true, all relative URLs will be canonicalized using baseURL + --cleanDestinationDir remove files from destination not found in static directories + -c, --contentDir string filesystem path to content directory + -d, --destination string filesystem path to write files to + --disable404 do not render 404 page + --disableFastRender enables full re-renders on changes + --disableKinds strings disable different kind of pages (home, RSS etc.) + --disableLiveReload watch without enabling live browser reload on rebuild + --disableRSS do not build RSS files + --disableSitemap do not build Sitemap file + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + -h, --help help for server + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) + --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") + --memstats string log memory usage to this file + --navigateToChanged navigate to changed content file on live browser reload + --noChmod don't sync permission mode of files + --noHTTPCache prevent HTTP caching + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + -p, --port int port on which the server will listen (default 1313) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --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 string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + --uglyURLs if true, use /filename.html instead of /filename/ + -w, --watch watch filesystem for changes and recreate as needed (default true) ``` ### Options inherited from parent commands @@ -88,4 +90,4 @@ hugo server [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_undraft.md b/content/commands/hugo_undraft.md index f13df1b8634..d324342dc67 100644 --- a/content/commands/hugo_undraft.md +++ b/content/commands/hugo_undraft.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo undraft" slug: hugo_undraft url: /commands/hugo_undraft/ @@ -40,4 +40,4 @@ hugo undraft path/to/content [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/commands/hugo_version.md b/content/commands/hugo_version.md index f92a899b7f1..aba0b7b552f 100644 --- a/content/commands/hugo_version.md +++ b/content/commands/hugo_version.md @@ -1,5 +1,5 @@ --- -date: 2017-09-26T21:11:49+02:00 +date: 2017-10-15T10:19:48+02:00 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ @@ -38,4 +38,4 @@ hugo version [flags] ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 26-Sep-2017 +###### Auto generated by spf13/cobra on 15-Oct-2017 diff --git a/content/content-management/cross-references.md b/content/content-management/cross-references.md index 55335d6a031..8c3155c00bd 100644 --- a/content/content-management/cross-references.md +++ b/content/content-management/cross-references.md @@ -1,5 +1,5 @@ --- -title: Cross References +title: Links and Cross References description: Hugo makes it easy to link documents together. date: 2017-02-01 publishdate: 2017-02-01 diff --git a/content/content-management/menus.md b/content/content-management/menus.md index f5e2e1b5c45..8de808391ed 100644 --- a/content/content-management/menus.md +++ b/content/content-management/menus.md @@ -18,7 +18,7 @@ toc: true --- {{% note "Lazy Blogger"%}} -If all you want is a simple menu for your sections, see the ["Section Menu for Lazy Bloggers" in Menu Templates](/templates/menu-templates/#section-menu-for-lazy-blogger). +If all you want is a simple menu for your sections, see the ["Section Menu for Lazy Bloggers" in Menu Templates](/templates/menu-templates/#section-menu-for-lazy-bloggers). {{% /note %}} You can do this: diff --git a/content/content-management/syntax-highlighting.md b/content/content-management/syntax-highlighting.md index 9b801ed202f..f2ff55fe167 100644 --- a/content/content-management/syntax-highlighting.md +++ b/content/content-management/syntax-highlighting.md @@ -22,21 +22,21 @@ If you want to continue to use Pygments (see below), set `pygmentsUseClassic=tru The example below shows a simple code snippet from the Hugo source highlighted with the `highlight` shortcode. Note that the gohugo.io site is generated with `pygmentsUseClasses=true` (see [Generate Syntax Highlighter CSS](#generate-syntax-highlighter-css)). -* `linenos=inline` turns on line numbers. Note that the `inline` value only has an effect in Pygments. +* `linenos=inline` or `linenos=table` (`table` will give copy-and-paste friendly code blocks) turns on line numbers. * `hl_lines` lists a set of line numbers or line number ranges to be highlighted. Note that the hyphen range syntax is only supported for Chroma. * `linenostart=199` starts the line number count from 199. With that, this: ``` -{{}} +{{}} // ... code {{}} ``` Gives this: -{{< highlight go "linenos=inline,hl_lines=8 15-17,linenostart=199" >}} +{{< highlight go "linenos=table,hl_lines=8 15-17,linenostart=199" >}} // GetTitleFunc returns a func that can be used to transform a string to // title case. // @@ -106,7 +106,7 @@ The full set of supported options for Pygments is: `encoding`, `outencoding`, `n ## Generate Syntax Highlighter CSS -If you run with `pygmentsUseClassic=true` in your site config, you need a style sheet. +If you run with `pygmentsUseClasses=true` in your site config, you need a style sheet. You can generate one with Hugo: diff --git a/content/content-management/toc.md b/content/content-management/toc.md index f4e86d49eec..681416a724e 100644 --- a/content/content-management/toc.md +++ b/content/content-management/toc.md @@ -45,6 +45,10 @@ Hugo will take this Markdown and create a table of contents from `## Introductio The built-in `.TableOfContents` variables outputs a `