diff --git a/archetypes/showcase/bio.md b/archetypes/showcase/bio.md new file mode 100644 index 000000000..2443c2f35 --- /dev/null +++ b/archetypes/showcase/bio.md @@ -0,0 +1,8 @@ + +Add some **general info** about {{ replace .Name "-" " " | title }} here. + +The site is built by: + +* [Person 1](https://example.com) +* [Person 1](https://example.com) + diff --git a/archetypes/showcase/featured.png b/archetypes/showcase/featured.png new file mode 100644 index 000000000..4f390132e Binary files /dev/null and b/archetypes/showcase/featured.png differ diff --git a/archetypes/showcase/index.md b/archetypes/showcase/index.md new file mode 100644 index 000000000..a21bb9726 --- /dev/null +++ b/archetypes/showcase/index.md @@ -0,0 +1,37 @@ +--- + +title: {{ replace .Name "-" " " | title }} +date: {{ now.Format "2006-01-02" }} + +description: "A short description of this page." + +# The URL to the site on the internet. +siteURL: https://gohugo.io/ + +# Link to the site's Hugo source code if public and you can/want to share. +# Remove or leave blank if not needed/wanted. +siteSource: https://github.com/gohugoio/hugoDocs + +# Add credit to the article author. Leave blank or remove if not needed/wanted. +byline: "[bep](https://github.com/bep), Hugo Lead" + +--- + +To complete this showcase: + +1. Write the story about your site in this file. +2. Add a summary to the `bio.md` file in this folder. +3. Replace the `featured-template.png` with a screenshot of your site. You can rename it, but it must contain the word `featured`. +4. Create a new pull request in https://github.com/gohugoio/hugoDocs/pulls + +The content of this bundle explained: + +index.md +: The main content file. Fill in required front matter metadata and write your story. I does not have to be a novel. It can even be self-promotional, but it should include Hugo in some form. + +bio.md +: A short summary of the website. Site credits (who built it) fits nicely here. + +featured.png +: A reasonably sized screenshot of your website. It can be named anything, but the name must start with "featured". The sample image is `1500x750` (2:1 aspect ratio). + diff --git a/config.toml b/config.toml index 8a0634467..d6de68a8b 100644 --- a/config.toml +++ b/config.toml @@ -69,7 +69,7 @@ twitter = "GoHugoIO" [params] description = "The world’s fastest framework for building websites" ## Used for views in rendered HTML (i.e., rather than using the .Hugo variable) - release = "0.48" + release = "0.49.2" ## Setting this to true will add a "noindex" to *EVERY* page on the site removefromexternalsearch = false ## Gh repo for site footer (include trailing slash) @@ -107,7 +107,7 @@ twitter = "GoHugoIO" # Note that you can also set this per image processing. resampleFilter = "CatmullRom" -# Defatult JPEG quality setting. Default is 75. +# Default JPEG quality setting. Default is 75. quality = 75 anchor = "smart" diff --git a/content/en/about/new-in-032/index.md b/content/en/about/new-in-032/index.md index 5ae688fc6..f3e56dc6b 100644 --- a/content/en/about/new-in-032/index.md +++ b/content/en/about/new-in-032/index.md @@ -199,7 +199,7 @@ You can configure an `imaging` section in `config.toml` with default image proce # See https://github.com/disintegration/imaging resampleFilter = "box" -# Defatult JPEG quality setting. Default is 75. +# Default JPEG quality setting. Default is 75. quality = 68 ``` diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md index 1f35ba594..add644e1c 100644 --- a/content/en/commands/hugo.md +++ b/content/en/commands/hugo.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo" slug: hugo url: /commands/hugo/ @@ -24,44 +24,40 @@ 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 (deprecated) 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 - --disableKinds strings disable different kind of pages (home, RSS etc.) - --enableGitInfo add Git revision, date and author info to the pages - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -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) - --minify minify any supported output format (HTML, XML etc.) - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --pluralizeListTitles (deprecated) pluralize titles in lists using inflect (default true) - --preserveTaxonomyNames (deprecated) 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 (deprecated) 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/ + --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 + --disableKinds strings disable different kind of pages (home, RSS etc.) + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -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) + --minify minify any supported output format (HTML, XML etc.) + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --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 + -v, --verbose verbose output + --verboseLog verbose logging + -w, --watch watch filesystem for changes and recreate as needed ``` ### SEE ALSO @@ -78,4 +74,4 @@ hugo [flags] * [hugo server](/commands/hugo_server/) - A high performance webserver * [hugo version](/commands/hugo_version/) - Print the version number of Hugo -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_benchmark.md b/content/en/commands/hugo_benchmark.md index 56debca69..3a8c58846 100644 --- a/content/en/commands/hugo_benchmark.md +++ b/content/en/commands/hugo_benchmark.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo benchmark" slug: hugo_benchmark url: /commands/hugo_benchmark/ @@ -20,38 +20,34 @@ 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 (deprecated) 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 - --disableKinds strings disable different kind of pages (home, RSS etc.) - --enableGitInfo add Git revision, date and author info to the pages - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -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 (deprecated) pluralize titles in lists using inflect (default true) - --preserveTaxonomyNames (deprecated) 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 (deprecated) 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/ + --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 + --disableKinds strings disable different kind of pages (home, RSS etc.) + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -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 + --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 ``` ### Options inherited from parent commands @@ -70,4 +66,4 @@ hugo benchmark [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_check.md b/content/en/commands/hugo_check.md index e8af96413..ef982f32d 100644 --- a/content/en/commands/hugo_check.md +++ b/content/en/commands/hugo_check.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 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 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_check_ulimit.md b/content/en/commands/hugo_check_ulimit.md index 5f2e265b8..5c2f1a5d2 100644 --- a/content/en/commands/hugo_check_ulimit.md +++ b/content/en/commands/hugo_check_ulimit.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo check ulimit" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ @@ -39,4 +39,4 @@ hugo check ulimit [flags] * [hugo check](/commands/hugo_check/) - Contains some verification checks -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_config.md b/content/en/commands/hugo_config.md index 37033bff0..a7b47fbbe 100644 --- a/content/en/commands/hugo_config.md +++ b/content/en/commands/hugo_config.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo config" slug: hugo_config url: /commands/hugo_config/ @@ -39,4 +39,4 @@ hugo config [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_convert.md b/content/en/commands/hugo_convert.md index 60ff1a81e..18bce9182 100644 --- a/content/en/commands/hugo_convert.md +++ b/content/en/commands/hugo_convert.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 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 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_convert_toJSON.md b/content/en/commands/hugo_convert_toJSON.md index 2643e79fb..cd3fa68a1 100644 --- a/content/en/commands/hugo_convert_toJSON.md +++ b/content/en/commands/hugo_convert_toJSON.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ @@ -42,4 +42,4 @@ hugo convert toJSON [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_convert_toTOML.md b/content/en/commands/hugo_convert_toTOML.md index a3441daf4..78f5591a4 100644 --- a/content/en/commands/hugo_convert_toTOML.md +++ b/content/en/commands/hugo_convert_toTOML.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ @@ -42,4 +42,4 @@ hugo convert toTOML [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_convert_toYAML.md b/content/en/commands/hugo_convert_toYAML.md index 300448b9f..75b0990ea 100644 --- a/content/en/commands/hugo_convert_toYAML.md +++ b/content/en/commands/hugo_convert_toYAML.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ @@ -42,4 +42,4 @@ hugo convert toYAML [flags] * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_env.md b/content/en/commands/hugo_env.md index bed60e7bb..8721b7f51 100644 --- a/content/en/commands/hugo_env.md +++ b/content/en/commands/hugo_env.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo env" slug: hugo_env url: /commands/hugo_env/ @@ -38,4 +38,4 @@ hugo env [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_gen.md b/content/en/commands/hugo_gen.md index 631163df9..5d06b3c9d 100644 --- a/content/en/commands/hugo_gen.md +++ b/content/en/commands/hugo_gen.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 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 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_gen_autocomplete.md b/content/en/commands/hugo_gen_autocomplete.md index da349c86d..906b58c82 100644 --- a/content/en/commands/hugo_gen_autocomplete.md +++ b/content/en/commands/hugo_gen_autocomplete.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo gen autocomplete" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ @@ -56,4 +56,4 @@ hugo gen autocomplete [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_gen_chromastyles.md b/content/en/commands/hugo_gen_chromastyles.md index 31999e25b..7e6b8dada 100644 --- a/content/en/commands/hugo_gen_chromastyles.md +++ b/content/en/commands/hugo_gen_chromastyles.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo gen chromastyles" slug: hugo_gen_chromastyles url: /commands/hugo_gen_chromastyles/ @@ -43,4 +43,4 @@ hugo gen chromastyles [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_gen_doc.md b/content/en/commands/hugo_gen_doc.md index 0634e623b..b2d5b6afe 100644 --- a/content/en/commands/hugo_gen_doc.md +++ b/content/en/commands/hugo_gen_doc.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo gen doc" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ @@ -45,4 +45,4 @@ hugo gen doc [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_gen_man.md b/content/en/commands/hugo_gen_man.md index c5e8e5adc..a3ef86306 100644 --- a/content/en/commands/hugo_gen_man.md +++ b/content/en/commands/hugo_gen_man.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo gen man" slug: hugo_gen_man url: /commands/hugo_gen_man/ @@ -41,4 +41,4 @@ hugo gen man [flags] * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_import.md b/content/en/commands/hugo_import.md index 208b90203..21dc4b2bd 100644 --- a/content/en/commands/hugo_import.md +++ b/content/en/commands/hugo_import.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 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 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_import_jekyll.md b/content/en/commands/hugo_import_jekyll.md index 3b600fad4..7103000a3 100644 --- a/content/en/commands/hugo_import_jekyll.md +++ b/content/en/commands/hugo_import_jekyll.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo import jekyll" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ @@ -41,4 +41,4 @@ hugo import jekyll [flags] * [hugo import](/commands/hugo_import/) - Import your site from others. -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_list.md b/content/en/commands/hugo_list.md index 556124872..538c362e4 100644 --- a/content/en/commands/hugo_list.md +++ b/content/en/commands/hugo_list.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 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 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_list_drafts.md b/content/en/commands/hugo_list_drafts.md index 0a4739401..8e5d461bd 100644 --- a/content/en/commands/hugo_list_drafts.md +++ b/content/en/commands/hugo_list_drafts.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ @@ -39,4 +39,4 @@ hugo list drafts [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_list_expired.md b/content/en/commands/hugo_list_expired.md index 605b5d936..c276640dc 100644 --- a/content/en/commands/hugo_list_expired.md +++ b/content/en/commands/hugo_list_expired.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo list expired" slug: hugo_list_expired url: /commands/hugo_list_expired/ @@ -40,4 +40,4 @@ hugo list expired [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_list_future.md b/content/en/commands/hugo_list_future.md index 1b0ff5ef6..c5c887636 100644 --- a/content/en/commands/hugo_list_future.md +++ b/content/en/commands/hugo_list_future.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ @@ -40,4 +40,4 @@ hugo list future [flags] * [hugo list](/commands/hugo_list/) - Listing out various types of content -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_new.md b/content/en/commands/hugo_new.md index 8487e6c45..0ff1076ec 100644 --- a/content/en/commands/hugo_new.md +++ b/content/en/commands/hugo_new.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 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 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_new_site.md b/content/en/commands/hugo_new_site.md index 293e7636f..a2d054913 100644 --- a/content/en/commands/hugo_new_site.md +++ b/content/en/commands/hugo_new_site.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ @@ -43,4 +43,4 @@ hugo new site [path] [flags] * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_new_theme.md b/content/en/commands/hugo_new_theme.md index 1589f6fa0..6395b11da 100644 --- a/content/en/commands/hugo_new_theme.md +++ b/content/en/commands/hugo_new_theme.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ @@ -42,4 +42,4 @@ hugo new theme [name] [flags] * [hugo new](/commands/hugo_new/) - Create new content for your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_server.md b/content/en/commands/hugo_server.md index 005475a06..ffb3ee280 100644 --- a/content/en/commands/hugo_server.md +++ b/content/en/commands/hugo_server.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ @@ -30,46 +30,42 @@ 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 (deprecated) 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 - --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 - --enableGitInfo add Git revision, date and author info to the pages - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -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 (deprecated) pluralize titles in lists using inflect (default true) - -p, --port int port on which the server will listen (default 1313) - --preserveTaxonomyNames (deprecated) 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 (deprecated) 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/ + --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 + --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 + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + --gc enable to run some cleanup tasks (remove unused cache files) after the build + -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 + -p, --port int port on which the server will listen (default 1313) + --renderToDisk render to Destination path (default is render to memory & serve from there) + -s, --source string filesystem path to read files relative from + --stepAnalysis display memory and timing of different steps of the program + --templateMetrics display metrics about template executions + --templateMetricsHints calculate some improvement hints when combined with --templateMetrics + -t, --theme string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + -w, --watch watch filesystem for changes and recreate as needed (default true) ``` ### Options inherited from parent commands @@ -88,4 +84,4 @@ hugo server [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/commands/hugo_version.md b/content/en/commands/hugo_version.md index 8249cd528..9a573ae4f 100644 --- a/content/en/commands/hugo_version.md +++ b/content/en/commands/hugo_version.md @@ -1,5 +1,5 @@ --- -date: 2018-08-17 +date: 2018-09-24 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ @@ -38,4 +38,4 @@ hugo version [flags] * [hugo](/commands/hugo/) - hugo builds your site -###### Auto generated by spf13/cobra on 17-Aug-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 diff --git a/content/en/content-management/archetypes.md b/content/en/content-management/archetypes.md index ff4a2d783..3fc8a9f3f 100644 --- a/content/en/content-management/archetypes.md +++ b/content/en/content-management/archetypes.md @@ -70,6 +70,28 @@ It will create a new newsletter type of content file based on the archetype temp The above _newsletter type archetype_ illustrates the possibilities: The full Hugo `.Site` and all of Hugo's template funcs can be used in the archetype file. +## Directory based archetypes + +Since Hugo `0.49` you can use complete directories as archetype templates. Given this archetype directory: + +```bash +archetypes +├── default.md +└── post-bundle + ├── bio.md + ├── images + │ └── featured.jpg + └── index.md +``` + +```bash +hugo new --kind post-bundle post/my-post +``` + +Will create a new folder in `/content/post/my-post` with the same set of files as in the `post-bundle` archetypes folder. All content files (`index.md` etc.) can contain template logic, and will receive the correct `.Site` for the content's language. + + + [archetypes directory]: /getting-started/directory-structure/ [content types]: /content-management/types/ [front matter]: /content-management/front-matter/ diff --git a/content/en/content-management/cross-references.md b/content/en/content-management/cross-references.md index 00f6ad1c1..59733555b 100644 --- a/content/en/content-management/cross-references.md +++ b/content/en/content-management/cross-references.md @@ -42,7 +42,7 @@ You will get an error if you document could not be uniquely resolved. The error Link to another language version of a document, you need to use this syntax: ```go-html-template -{{}} +{{}} ``` ### Get another Output Format diff --git a/content/en/content-management/formats.md b/content/en/content-management/formats.md index f7a466c3c..e666351a1 100644 --- a/content/en/content-management/formats.md +++ b/content/en/content-management/formats.md @@ -1,7 +1,7 @@ --- title: Supported Content Formats linktitle: Supported Content Formats -description: Markdown and Emacs Org-Mode have native support, and additional formats (e.g. Asciidoc) come via external helpers. +description: Both HTML and Markdown are supported content formats. date: 2017-01-10 publishdate: 2017-01-10 lastmod: 2017-04-06 @@ -19,7 +19,19 @@ toc: true **Markdown is the main content format** and comes in two flavours: The excellent [Blackfriday project][blackfriday] (name your files `*.md` or set `markup = "markdown"` in front matter) or its fork [Mmark][mmark] (name your files `*.mmark` or set `markup = "mmark"` in front matter), both very fast markdown engines written in Go. -For Emacs users, [goorgeous](https://github.com/chaseadamsio/goorgeous) provides built-in native support for Org-mode (name your files `*.org` or set `markup = "org"` in front matter) +For Emacs users, [goorgeous](https://github.com/chaseadamsio/goorgeous) provides built-in native support for Org-mode (name your files `*.org` or set `markup = "org"` in front matter) + +But in many situations, plain HTML is what you want. Just name your files with `.html` or `.htm` extension inside your content folder. Note that if you want your HTML files to have a layout, they need front matter. It can be empty, but it has to be there: + +```html +--- +title: "This is a content file in HTML" +--- + +
+

Hello, Hugo!

+
+``` {{% note "Deeply Nested Lists" %}} Before you begin writing your content in markdown, Blackfriday has a known issue [(#329)](https://github.com/russross/blackfriday/issues/329) with handling deeply nested lists. Luckily, there is an easy workaround. Use 4-spaces (i.e., tab) rather than 2-space indentations. diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 9ad1d3804..4cf6825da 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -59,6 +59,9 @@ There are a few predefined variables that Hugo is aware of. See [Page Variables] aliases : an array of one or more aliases (e.g., old published paths of renamed content) that will be created in the output directory structure . See [Aliases][aliases] for details. +audio +: an array of paths to audio files related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:audio`. + date : the datetime at which the content was created; note this value is auto-populated according to Hugo's built-in [archetype][]. @@ -74,6 +77,9 @@ expiryDate headless : if `true`, sets a leaf bundle to be [headless][headless-bundle]. +images +: an array of paths to images related to the page; used by [internal templates](/templates/internal) such as `_internal/twitter_cards.html`. + isCJKLanguage : if `true`, Hugo will explicitly treat the content as a CJK language; both `.Summary` and `.WordCount` work properly in CJK languages. @@ -101,6 +107,9 @@ publishDate resources : used for configuring page bundle resources. See [Page Resources][page-resources]. +series +: an array of series this page belongs to, as a subset of the `series` [taxonomy](/content-management/taxonomies/); used by the `opengraph` [internal template](/templates/internal) to populate `og:see_also`. + slug : appears as the tail of the output URL. A value specified in front matter will override the segment of the URL based on the filename. @@ -114,6 +123,9 @@ url : the full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of the multilingual feature. +videos +: an array of paths to videos related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:video`. + weight : used for [ordering your content in lists][ordering]. Lower weight gets higher precedence. So content with lower weight will come first. diff --git a/content/en/content-management/image-processing/index.md b/content/en/content-management/image-processing/index.md index b26a9c059..b83a6c103 100644 --- a/content/en/content-management/image-processing/index.md +++ b/content/en/content-management/image-processing/index.md @@ -151,7 +151,7 @@ You can configure an `imaging` section in `config.toml` with default image proce # See https://github.com/disintegration/imaging resampleFilter = "box" -# Defatult JPEG quality setting. Default is 75. +# Default JPEG quality setting. Default is 75. quality = 75 # Anchor used when cropping pictures. diff --git a/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index 45b614351..c72cb50ce 100644 --- a/content/en/content-management/multilingual.md +++ b/content/en/content-management/multilingual.md @@ -29,6 +29,7 @@ The following is an example of a site configuration for a multilingual Hugo proj DefaultContentLanguage = "en" copyright = "Everything is mine" +[params] [params.navigation] help = "Help" @@ -48,8 +49,7 @@ linkedin = "https://linkedin.com/fr/whoever" help = "Aide" {{< /code-toggle >}} -Anything not defined in a `[languages]` block will fall back to the global -value for that key (e.g., `copyright` for the English [`en`] language). +Anything not defined in a `[languages]` block will fall back to the global value for that key (e.g., `copyright` for the English [`en`] language). This also works for `params`, as demonstrated witgh `help` above: You will get the value `Aide` in French and `Help` in all the languages without this parameter set. With the configuration above, all content, sitemap, RSS feeds, paginations, and taxonomy pages will be rendered below `/` in English (your default content language) and then below `/fr` in French. @@ -67,7 +67,7 @@ Only the obvious non-global options can be overridden per language. Examples of You can disable one or more languages. This can be useful when working on a new translation. ```toml -disableLanguages = ["fr", "jp"] +disableLanguages = ["fr", "ja"] ``` Note that you cannot disable the default content language. @@ -75,7 +75,7 @@ Note that you cannot disable the default content language. We kept this as a standalone setting to make it easier to set via [OS environment](/getting-started/configuration/#configure-with-environment-variables): ```bash -HUGO_DISABLELANGUAGES="fr jp" hugo +HUGO_DISABLELANGUAGES="fr ja" hugo ``` If you have already a list of disabled languages in `config.toml`, you can enable them in development like this: diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index f45cf4b01..c3c29e452 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -17,7 +17,7 @@ menu: ## Properties ResourceType -: The main type of the resource. For example, a file of MIME type `image/jpg` has for ResourceType `image`. +: The main type of the resource. For example, a file of MIME type `image/jpg` has the ResourceType `image`. Name : Default value is the filename (relative to the owning page). Can be set in front matter. @@ -31,6 +31,21 @@ Permalink RelPermalink : The relative URL to the resource. Resources of type `page` will have no value. +Content +: The content of the resource itself. For most resources, this returns a string with the contents of the file. This can be used to inline some resources, such as `` or ``. + +MediaType +: The MIME type of the resource, such as `image/jpg`. + +MediaType.MainType +: The main type of the resource's MIME type. For example, a file of MIME type `application/pdf` has for MainType `application`. + +MediaType.SubType +: The subtype of the resource's MIME type. For example, a file of MIME type `application/pdf` has for SubType `pdf`. Note that this is not the same as the file extension - PowerPoint files have a subtype of `vnd.mspowerpoint`. + +MediaType.Suffixes +: A slice of possible suffixes for the resource's MIME type. + ## Methods ByType : Returns the page resources of the given type. diff --git a/content/en/content-management/related.md b/content/en/content-management/related.md index 636e95970..e87aecca4 100644 --- a/content/en/content-management/related.md +++ b/content/en/content-management/related.md @@ -42,14 +42,14 @@ Here is the list of "Related" methods available on a page collection such `.Regu Returns a collection of pages related the given one. ``` -{{ $related := .RegularPages.Related . }} +{{ $related := .Site.RegularPages.Related . }} ``` #### .RelatedIndices PAGE INDICE1 [INDICE2 ...] Returns a collection of pages related to a given one restricted to a list of indices. ``` -{{ $related := .RegularPages.RelatedIndices . "tags" "date" }} +{{ $related := .Site.RegularPages.RelatedIndices . "tags" "date" }} ``` #### .RelatedTo KEYVALS [KEYVALS2 ...] @@ -58,7 +58,7 @@ Returns a collection of pages related together by a set of indices and their mat In order to build those set and pass them as argument, one must use the `keyVals` function where the first agrument would be the `indice` and the consective ones its potential `matches`. ``` -{{ $related := .RegularPages.RelatedTo ( keyVals "tags" "hugo" "rocks") ( keyVals "date" .Date ) }} +{{ $related := .Site.RegularPages.RelatedTo ( keyVals "tags" "hugo" "rocks") ( keyVals "date" .Date ) }} ``` {{% note %}} diff --git a/content/en/content-management/taxonomies.md b/content/en/content-management/taxonomies.md index 629fab94d..c06b2385b 100644 --- a/content/en/content-management/taxonomies.md +++ b/content/en/content-management/taxonomies.md @@ -139,7 +139,7 @@ If you want to disable all taxonomies altogether, see the use of `disableKinds` By default, taxonomy names are normalized. -Therefore, if you want to have a taxonomy term with special characters such as `Gérard Depardieu` instead of `Gerard Depardieu`, set the value for `preserveTaxonomyNames` to `true` in your [site config][config]. Hugo will then preserve special characters in taxonomy values but will still title-ize the values for titles and normalize them in URLs. +Therefore, if you want to have a taxonomy term with special characters such as `Gérard Depardieu` instead of `Gerard Depardieu`, set the value for `preserveTaxonomyNames` to `true` in your [site config][config]. Hugo will then preserve special characters in taxonomy values but will still normalize them in URLs. Note that if you use `preserveTaxonomyNames` and intend to manually construct URLs to the archive pages, you will need to pass the taxonomy values through the [`urlize` template function][]. @@ -149,6 +149,12 @@ You can add content and front matter to your taxonomy list and taxonomy terms pa Much like regular pages, taxonomy list [permalinks](/content-management/urls/) are configurable, but taxonomy term page permalinks are not. {{% /note %}} +{{% warning "`preserveTaxonomyNames` behaviour change" %}} +Before 0.49, Hugo would make the first character upper case for the taxonomy values for titles even if `preserveTaxonomyNames` was active. This no longer the case, which (for instance) makes it possible to have fully lower-case values. + +If you actually need to title-ize these values, you can do so using the `strings.FirstUpper` template function. +{{% /warning %}} + ## Add Taxonomies to Content Once a taxonomy is defined at the site level, any piece of content can be assigned to it, regardless of [content type][] or [content section][]. diff --git a/content/en/contribute/development.md b/content/en/contribute/development.md index e9e1cd10f..93b31ee8c 100644 --- a/content/en/contribute/development.md +++ b/content/en/contribute/development.md @@ -83,7 +83,7 @@ If you're going to contribute code, you'll need to have an account on GitHub. Go ## Install Git on Your System -You will need to have Git installed on your computer to contribute to Hugo development. Teaching Git is outside the scope of the Hugo docs, but if you're looking for an excellent reference to learn the basics of Git, we recommend the [Git book][gitbook] if you are not sure where to begin. We will include short explainations of the Git commands in this document. +You will need to have Git installed on your computer to contribute to Hugo development. Teaching Git is outside the scope of the Hugo docs, but if you're looking for an excellent reference to learn the basics of Git, we recommend the [Git book][gitbook] if you are not sure where to begin. We will include short explanations of the Git commands in this document. Git is a [version control system](https://en.wikipedia.org/wiki/Version_control) to track the changes of source code. Hugo depends on smaller third-party packages that are used to extend the functionality. We use them because we don't want to reinvent the wheel. @@ -242,7 +242,7 @@ Sometimes changes on the codebase can cause unintended side effects. Or they don Make sure the commands `go test ./...` passes, and `go build` completes. ### Formatting -The Go code styleguide maybe is opinionated but it ensures that the codebase looks the same, regardless who wrote the code. Go comes with its own formatting tool. Let's apply the styleguide to our addtions: +The Go code styleguide maybe is opinionated but it ensures that the codebase looks the same, regardless who wrote the code. Go comes with its own formatting tool. Let's apply the styleguide to our additions: ``` go fmt ./... diff --git a/content/en/functions/NumFmt.md b/content/en/functions/NumFmt.md index 795eaaea8..1bc07abd5 100644 --- a/content/en/functions/NumFmt.md +++ b/content/en/functions/NumFmt.md @@ -12,7 +12,7 @@ menu: docs: parent: "functions" toc: false -signature: ["lang.NumFmt PRECISION NUMBER [OPTIONS]"] +signature: ["lang.NumFmt PRECISION NUMBER [OPTIONS [DELIMITER]]"] workson: [] hugoversion: relatedfuncs: [] @@ -22,7 +22,9 @@ aliases: [] comments: --- -The default options value is `- . ,`. +The default options value is `- . ,`. The default delimiter within the options +value is a space. If you need to use a space as one of the options, set a +custom delimiter. Numbers greater than or equal to 5 are rounded up. For example, if precision is set to `0`, `1.5` becomes `2`, and `1.4` becomes `1`. @@ -31,5 +33,6 @@ Numbers greater than or equal to 5 are rounded up. For example, if precision is {{ lang.NumFmt 2 12345.6789 "- , ." }} → 12.345,68 {{ lang.NumFmt 0 -12345.6789 "- . ," }} → -12,346 {{ lang.NumFmt 6 -12345.6789 "- ." }} → -12345.678900 +{{ lang.NumFmt 6 -12345.6789 "-|.| " "|" }} → -1 2345.678900 {{ -98765.4321 | lang.NumFmt 2 }} → -98,765.43 ``` diff --git a/content/en/functions/anchorize.md b/content/en/functions/anchorize.md new file mode 100644 index 000000000..a0745edaf --- /dev/null +++ b/content/en/functions/anchorize.md @@ -0,0 +1,26 @@ +--- +title: anchorize +description: Takes a string and sanitizes it the same way as Blackfriday does for markdown headers. +date: 2018-10-13 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [markdown,strings] +signature: ["anchorize INPUT"] +hugoversion: "0.39" +workson: [] +relatedfuncs: [humanize] +--- + +The template function uses the [`SanitizedAnchorName` logic from Blackfriday](https://github.com/russross/blackfriday#sanitized-anchor-names). +Since the same sanitizing logic is used as the markdown parser, you can determine the ID of a header for linking with anchor tags. + +``` +{{anchorize "This is a header"}} → "this-is-a-header" +{{anchorize "This is also a header"}} → "this-is-also-a-header" +{{anchorize "main.go"}} → "main-go" +{{anchorize "Article 123"}} → "article-123" +{{anchorize "<- Let's try this, shall we?"}} → "let-s-try-this-shall-we" +{{anchorize "Hello, 世界"}} → "hello-世界" +``` diff --git a/content/en/functions/append.md b/content/en/functions/append.md new file mode 100644 index 000000000..732ffeadd --- /dev/null +++ b/content/en/functions/append.md @@ -0,0 +1,38 @@ +--- +title: append +description: "`append` appends one or more values to a slice and returns the resulting slice." +date: 2018-09-14 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [collections] +signature: ["COLLECTION | append VALUE [VALUE]...", "COLLECTION | append COLLECTION"] +workson: [] +hugoversion: "0.49" +relatedfuncs: [last,first,where,slice] +aliases: [] +--- + +An example appending single values: + +```go-html-template +{{ $s := slice "a" "b" "c" }} +{{ $s = $s | append "d" "e" }} +{{/* $s now contains a []string with elements "a", "b", "c", "d", and "e" */}} + +``` + +The same example appending a slice to a slice: + + +```go-html-template +{{ $s := slice "a" "b" "c" }} +{{ $s = $s | append (slice "d" "e") }} +``` + +The `append` function works for all types, including `Pages`. + + + + diff --git a/content/en/functions/first.md b/content/en/functions/first.md index 464dfa671..e4c0a848d 100644 --- a/content/en/functions/first.md +++ b/content/en/functions/first.md @@ -25,3 +25,5 @@ aliases: [] {{ .Render "summary" }} {{ end }} ``` + +*Note: Exclusive to `first`, LIMIT can be '0' to return an empty array.* diff --git a/content/en/functions/group.md b/content/en/functions/group.md new file mode 100644 index 000000000..e1a22ef5d --- /dev/null +++ b/content/en/functions/group.md @@ -0,0 +1,37 @@ +--- +title: group +description: "`group` groups a list of pages." +date: 2018-09-14 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [collections] +signature: ["PAGES | group KEY"] +hugoversion: "0.49" +--- + +{{< code file="layouts/partials/groups.html" >}} +{{ $new := .Site.RegularPages | first 10 | group "New" }} +{{ $old := .Site.RegularPages | last 10 | group "Old" }} +{{ $groups := slice $new $old }} +{{ range $groups }} +

{{ .Key }}{{/* Prints "New", "Old" */}}

+ +{{ end }} +{{< /code >}} + + + +The page group you get from `group` is of the same type you get from the built-in [group methods](/templates/lists#group-content) in Hugo. The above example can even be [paginated](/templates/pagination/#list-paginator-pages). + + + + diff --git a/content/en/functions/humanize.md b/content/en/functions/humanize.md index 2b9a98132..fe06de3a7 100644 --- a/content/en/functions/humanize.md +++ b/content/en/functions/humanize.md @@ -14,7 +14,7 @@ keywords: [strings,casing] signature: ["humanize INPUT"] workson: [] hugoversion: -relatedfuncs: [] +relatedfuncs: [anchorize] deprecated: false aliases: [] --- @@ -28,4 +28,3 @@ If the input is either an int64 value or the string representation of an integer {{humanize "52"}} → "52nd" {{humanize 103}} → "103rd" ``` - diff --git a/content/en/functions/range.md b/content/en/functions/range.md index 6f007e93d..f80967c41 100644 --- a/content/en/functions/range.md +++ b/content/en/functions/range.md @@ -22,4 +22,4 @@ aliases: [] Just like in the Go programming language, Go and Hugo templates make heavy use of `range` to iterate over a map, array or slice. -`range` is fundamental to templating in Hugo. (See the [Introduction to Hugo Templates](/templates/introduction/) for more examples. +`range` is fundamental to templating in Hugo. (See the [Introduction to Hugo Templates](/templates/introduction/) for more examples.) diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index f43c51b9b..77ef30e4f 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -126,6 +126,9 @@ languages languageCode ("") : The site's language code. +languageName ("") +: The site's language name. + disableLanguages : See [Disable a Language](/content-management/multilingual/#disable-a-language) diff --git a/content/en/getting-started/installing.md b/content/en/getting-started/installing.md index b5b210d3e..e73511c5b 100644 --- a/content/en/getting-started/installing.md +++ b/content/en/getting-started/installing.md @@ -86,10 +86,10 @@ mkdir $HOME/src cd $HOME/src git clone https://github.com/gohugoio/hugo.git cd hugo -go install +go install --tags extended {{< /code >}} -Remove `HUGO_BUILD_TAGS=extended` if you do not want Sass/SCSS support. +Remove `--tags extended` if you do not want/need Sass/SCSS support. {{% note %}} If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`. diff --git a/content/en/news/0.45-relnotes/index.md b/content/en/news/0.45-relnotes/index.md index b67a24de6..83051c058 100644 --- a/content/en/news/0.45-relnotes/index.md +++ b/content/en/news/0.45-relnotes/index.md @@ -39,7 +39,7 @@ You can also use the `..` to refer to a page one level up etc.: We have now also added language support to `ref` and `relref`, so you can link to a page in another language: ```go-html-template -{{}} +{{}} ``` To link to a given Output Format of a document, you can use this syntax: diff --git a/content/en/news/0.49-relnotes/featured-hugo-49-poster.png b/content/en/news/0.49-relnotes/featured-hugo-49-poster.png new file mode 100644 index 000000000..6f0f42ed4 Binary files /dev/null and b/content/en/news/0.49-relnotes/featured-hugo-49-poster.png differ diff --git a/content/en/news/0.49-relnotes/index.md b/content/en/news/0.49-relnotes/index.md new file mode 100644 index 000000000..6bb272c33 --- /dev/null +++ b/content/en/news/0.49-relnotes/index.md @@ -0,0 +1,120 @@ + +--- +date: 2018-09-24 +title: "Hugo 0.49: Directory Based Archetypes" +description: "Hugo 0.49 brings archetype bundle support and collection goodness." +categories: ["Releases"] +--- + + +Hugo `0.49` brings [directory based archetypes](https://gohugo.io/content-management/archetypes/#directory-based-archetypes) and also improves the language handling in `hugo new`. This should simplify working with [page bundles](https://gohugo.io/content-management/page-bundles/). One example of this would be how you now can create a [new showcase](https://gohugo.io/showcase/template/) for the Hugo web site. + +But this release is also about _collections_. Go 1.11 gave us variable overwrite support in Go templates. That made it possible to simplify a lot of template constructs, but it also showed some limitations in Hugo's template functions. So with this release we have: + +* added [append](https://gohugo.io/functions/append/) function to append to collections. +* added [group](https://gohugo.io/functions/group/) to create custom page groups. +* improved the type support in [slice](https://gohugo.io/functions/slice/). + +This release represents **66 contributions by 9 contributors** to the main Hugo code base. +[@bep](https://github.com/bep) leads the Hugo development with a significant amount of contributions, but also a big shoutout to [@moorereason](https://github.com/moorereason), [@felicianotech](https://github.com/felicianotech), and [@vdanjean](https://github.com/vdanjean) for their ongoing contributions. +And a big thanks to [@digitalcraftsman](https://github.com/digitalcraftsman) and [@onedrawingperday](https://github.com/onedrawingperday) for their relentless work on keeping the themes site in pristine condition and to [@kaushalmodi](https://github.com/kaushalmodi) for his great work on the documentation site. + +Many have also been busy writing and fixing the documentation in [hugoDocs](https://github.com/gohugoio/hugoDocs), +which has received **37 contributions by 20 contributors**. A special thanks to [@bep](https://github.com/bep), [@kaushalmodi](https://github.com/kaushalmodi), [@AlexChambers](https://github.com/AlexChambers), and [@shaform](https://github.com/shaform) for their work on the documentation site. + + +Hugo now has: + +* 28985+ [stars](https://github.com/gohugoio/hugo/stargazers) +* 441+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) +* 265+ [themes](http://themes.gohugo.io/) + + +## Notes + +* Remove deprecated `rssURI` [f1a00b20](https://github.com/gohugoio/hugo/commit/f1a00b2069ede85feb487d29b9f690396e2402c6) [@bep](https://github.com/bep) +* Remove deprecated flags [df4cbbd3](https://github.com/gohugoio/hugo/commit/df4cbbd3bdc05aa14a67b3a0a29a0db75b82e640) [@bep](https://github.com/bep) +* Deprecate `Pages.Sort`. Use `.ByWeight` [2e2e34a9](https://github.com/gohugoio/hugo/commit/2e2e34a9350edec0220462aa3d47ecc9d428a0fb) [@bep](https://github.com/bep) +* When setting `preserveTaxonomyNames` Hugo now _really_ preserves them. Before this release, we would make the first character upper case. If this is the behaviour you want you can use the new `strings.FirstUpper` function. + +## Enhancements + +### Templates + +* Allow `first` function to return an empty slice [cae07ce8](https://github.com/gohugoio/hugo/commit/cae07ce84b3bd4a33fd18b5109a1a3c3dce2191c) [@felicianotech](https://github.com/felicianotech) [#5235](https://github.com/gohugoio/hugo/issues/5235) +* Use `safeHTMLAttr` instead of `safeHTML` for HTML attributes [4f9c109d](https://github.com/gohugoio/hugo/commit/4f9c109dc5431553e5dbf98e0ed37487c12e8d16) [@felicianotech](https://github.com/felicianotech) [#5236](https://github.com/gohugoio/hugo/issues/5236) +* Add `collections.Append` (with alias `append`) [e27fd4c1](https://github.com/gohugoio/hugo/commit/e27fd4c1b80b7acb43290ac50e9f140d690cf042) [@bep](https://github.com/bep) [#5190](https://github.com/gohugoio/hugo/issues/5190) +* Improve type handling in `collections.Slice` [fe6676c7](https://github.com/gohugoio/hugo/commit/fe6676c775b8d917a661238f24fd4a9088f25d50) [@bep](https://github.com/bep) [#5188](https://github.com/gohugoio/hugo/issues/5188) +* Add `group` template func [6667c6d7](https://github.com/gohugoio/hugo/commit/6667c6d7430acc16b3683fbbacd263f1d00c8672) [@bep](https://github.com/bep) [#4865](https://github.com/gohugoio/hugo/issues/4865) +* Add `strings.FirstUpper` [e5d66074](https://github.com/gohugoio/hugo/commit/e5d66074ce1ed4e0fe329e3fdef66f8b6fd5dc55) [@bep](https://github.com/bep) [#5174](https://github.com/gohugoio/hugo/issues/5174) + +### Core + +* Minor cleaning in the sorting code [2eed35c8](https://github.com/gohugoio/hugo/commit/2eed35c826e5de6aae432b36969a28c2ae3e0f02) [@bep](https://github.com/bep) +* Make sure ambiguous lookups in GetPage gets an error [75e54345](https://github.com/gohugoio/hugo/commit/75e54345f9a7d786bb28af64ad80eb9502fee7c7) [@bep](https://github.com/bep) [#5138](https://github.com/gohugoio/hugo/issues/5138) +* Allow creating page groups from any page collection [cfda13b3](https://github.com/gohugoio/hugo/commit/cfda13b36367465016f4458ab9924c948ed02b6f) [@vdanjean](https://github.com/vdanjean) [#4865](https://github.com/gohugoio/hugo/issues/4865) +* Do not FirstUpper taxonomy titles [be3ae3ec](https://github.com/gohugoio/hugo/commit/be3ae3ec92da972a55112af39ce2e1c45121b9a5) [@Schnouki](https://github.com/Schnouki) [#5172](https://github.com/gohugoio/hugo/issues/5172) +* Simplify some code [e38e8812](https://github.com/gohugoio/hugo/commit/e38e881248b7d20927eab0e56c85732e1acbc45e) [@moorereason](https://github.com/moorereason) +* Add missing error checks [0665a395](https://github.com/gohugoio/hugo/commit/0665a3951be6ffc2551ef6664856da4cfccd45fa) [@moorereason](https://github.com/moorereason) +* Remove extraneous createStaticFs call [1ed8c363](https://github.com/gohugoio/hugo/commit/1ed8c363367c2532014154e91eeade9b3a923f91) [@moorereason](https://github.com/moorereason) + +### Other + +* Add "go mod download" to CI scripts [cf47f43f](https://github.com/gohugoio/hugo/commit/cf47f43ff12ca5f5ea851a8b6761b19b5e4d4eba) [@bep](https://github.com/bep) +* Regenerate CLI docs [3b6bd121](https://github.com/gohugoio/hugo/commit/3b6bd1210a2792c51c34b9c655cb8b7e9a0f15d7) [@bep](https://github.com/bep) +* Document group [8388cd90](https://github.com/gohugoio/hugo/commit/8388cd90e89358f73ddcb7f496a1a8dc5c30c36c) [@bep](https://github.com/bep) +* Make Data.Integrity be of type template.HTMLAttr [fe6a6f27](https://github.com/gohugoio/hugo/commit/fe6a6f2737769070fd64a5192ff685c9c89020bd) [@bep](https://github.com/bep) +* Add directory based archetypes [2650fa77](https://github.com/gohugoio/hugo/commit/2650fa772b40846d9965f8c5f169286411f3beb2) [@bep](https://github.com/bep) [#4535](https://github.com/gohugoio/hugo/issues/4535) +* Build on CircleCI outside of GOPATH [ef525b15](https://github.com/gohugoio/hugo/commit/ef525b15d4584886b52428bd7a35de835ab07a48) [@felicianotech](https://github.com/felicianotech) [#5135](https://github.com/gohugoio/hugo/issues/5135) +* Prevent symbolic links from themes [f9168146](https://github.com/gohugoio/hugo/commit/f9168146978bd970d1f4fb061eff75264af88bb1) [@bep](https://github.com/bep) +* Update releasenotes_writer.go [4b82f748](https://github.com/gohugoio/hugo/commit/4b82f74848836efbcf453c0122bd35555ee7517d) [@bep](https://github.com/bep) +* Add docs for append [df50c108](https://github.com/gohugoio/hugo/commit/df50c108ba2f24936eff20b51d23f9328adb2d87) [@bep](https://github.com/bep) [#5190](https://github.com/gohugoio/hugo/issues/5190) +* Set minifier to KeepEndTags [9b26b548](https://github.com/gohugoio/hugo/commit/9b26b5487b5c5142fe9fb58681fe7d1dac95a291) [@onedrawingperday](https://github.com/onedrawingperday) +* Make JSON minification more generic [3dafe206](https://github.com/gohugoio/hugo/commit/3dafe206e31bb92f27802a04bf9159cbc20af234) [@zinefer](https://github.com/zinefer) +* Update Mage [37d64634](https://github.com/gohugoio/hugo/commit/37d6463479952f7dfba59d899eed38b41e223283) [@bep](https://github.com/bep) +* Update dependencies [bb2fe814](https://github.com/gohugoio/hugo/commit/bb2fe814c2db0c494b3b678a5da20a6cc0538857) [@bep](https://github.com/bep) +* Improve some godoc comments [30bc4ed0](https://github.com/gohugoio/hugo/commit/30bc4ed0a01f965cc2f9187ccb6ab5d28a3149f6) [@moorereason](https://github.com/moorereason) +* Update to latest Mage [3b103cb7](https://github.com/gohugoio/hugo/commit/3b103cb7b74228f26af5beb4cefc47edee794ce9) [@bep](https://github.com/bep) +* Remove some duplicate code [c15c7da4](https://github.com/gohugoio/hugo/commit/c15c7da42a1c7bc535cc16cca2b341526f8cf169) [@bep](https://github.com/bep) +* Update Dockerfile to Go 1.11 [bcbe57c6](https://github.com/gohugoio/hugo/commit/bcbe57c6e9243cbf3823f11b755f57c091cc1866) [@zyfdegh](https://github.com/zyfdegh) [#5145](https://github.com/gohugoio/hugo/issues/5145) +* Init packages once [ea8ef573](https://github.com/gohugoio/hugo/commit/ea8ef573c6f869de95fdf4b19765d34026de6471) [@bep](https://github.com/bep) +* Update script to Go 1.11 [293e1235](https://github.com/gohugoio/hugo/commit/293e12355dd9d9361774f5ab340cd8a03b4828a1) [@bep](https://github.com/bep) [#5127](https://github.com/gohugoio/hugo/issues/5127) +* Remove the remains of Go Dep [fdf3c3b8](https://github.com/gohugoio/hugo/commit/fdf3c3b8234ed340f40a85fb76d96ae3a9ccf195) [@bep](https://github.com/bep) [#5115](https://github.com/gohugoio/hugo/issues/5115) +* Update CONTRIBUTING.md [312d2252](https://github.com/gohugoio/hugo/commit/312d2252be6b7bf250fa4f8b1b541fdc13641940) [@bep](https://github.com/bep) +* Update README.md [f627903e](https://github.com/gohugoio/hugo/commit/f627903efaa1a5f7e137c2d409efd1e1e2db47f6) [@bep](https://github.com/bep) +* Fix golint issues [400fe96a](https://github.com/gohugoio/hugo/commit/400fe96aee8e38112e347e762661b8389701c938) [@moorereason](https://github.com/moorereason) +* Fix golint godoc issues [3f45e729](https://github.com/gohugoio/hugo/commit/3f45e729f4e0296bb1a3558d60087bec8321444b) [@moorereason](https://github.com/moorereason) +* Fix godoc comment [e03eb90a](https://github.com/gohugoio/hugo/commit/e03eb90a366159ed9ef9888246de87f283508866) [@moorereason](https://github.com/moorereason) +* Fix typo in private func name [c915d0d3](https://github.com/gohugoio/hugo/commit/c915d0d3252007d61b680a388dcbe6b035d0adc8) [@moorereason](https://github.com/moorereason) +* Fix golint godoc issues [f6f22ad9](https://github.com/gohugoio/hugo/commit/f6f22ad944a1c308fd823792b2fbff1504f42cef) [@moorereason](https://github.com/moorereason) +* Fix filepath issue in test [d970327d](https://github.com/gohugoio/hugo/commit/d970327d7b994b495ef3bb468c3e0599b0deef5a) [@moorereason](https://github.com/moorereason) +* Fix golint issues [0013bea9](https://github.com/gohugoio/hugo/commit/0013bea901ee2124f4c18f9728abf47c3880f97d) [@moorereason](https://github.com/moorereason) +* Fix golint godoc issue [ffaa73dc](https://github.com/gohugoio/hugo/commit/ffaa73dc8aa860edb3476b2a460774071b8470a4) [@moorereason](https://github.com/moorereason) +* Fix golint godoc issue [f8d8c854](https://github.com/gohugoio/hugo/commit/f8d8c85428f527139c20369910230741dcaf2969) [@moorereason](https://github.com/moorereason) +* Fix golint issue [10dc87bf](https://github.com/gohugoio/hugo/commit/10dc87bf866f7a4f99c248436c38edf0ecdd157f) [@moorereason](https://github.com/moorereason) +* Fix golint issues [7231869b](https://github.com/gohugoio/hugo/commit/7231869ba87f4e8d08e94dce18f20b7ed4fa2e15) [@moorereason](https://github.com/moorereason) +* Fix golint godoc issues [600047ff](https://github.com/gohugoio/hugo/commit/600047ff1cb95d061af1983b9a755157eb4941f8) [@moorereason](https://github.com/moorereason) +* Fix golint issues [5f2e1cb8](https://github.com/gohugoio/hugo/commit/5f2e1cb8969c2adac6c866b57cc331e1bc16d4e9) [@moorereason](https://github.com/moorereason) +* Fix golint issues [c8ce6504](https://github.com/gohugoio/hugo/commit/c8ce65046dc7539f3bf5f6dd35fa7ece2bec866d) [@moorereason](https://github.com/moorereason) +* Fix most golint issues [a53f9623](https://github.com/gohugoio/hugo/commit/a53f962312e273cea9fe460b40655350a82210f2) [@moorereason](https://github.com/moorereason) +* Fix golint issues [daffeec3](https://github.com/gohugoio/hugo/commit/daffeec30d9d67017ec84064e15fd946b0b0cb0d) [@moorereason](https://github.com/moorereason) +* Fix golint errors [b8b91f55](https://github.com/gohugoio/hugo/commit/b8b91f550646b2620649c3504e14a441975bea9f) [@moorereason](https://github.com/moorereason) +* Fix golint issues [f0effac8](https://github.com/gohugoio/hugo/commit/f0effac80426325040c4bc703cd610f434d0b5a8) [@moorereason](https://github.com/moorereason) +* Fix broken Travis config [2cf8fe2e](https://github.com/gohugoio/hugo/commit/2cf8fe2ea218d37776af72893691e772737750e3) [@bep](https://github.com/bep) +* Fix error message for go vet [47d4edce](https://github.com/gohugoio/hugo/commit/47d4edce6083bab1c190dad99fefb7c73afc6af8) [@mdhender](https://github.com/mdhender) + + +## Fixes + +* Compare every element in pages cache [ed4f1edb](https://github.com/gohugoio/hugo/commit/ed4f1edbd729bf75af89879b76fbad931693cd67) [@bep](https://github.com/bep) [#5239](https://github.com/gohugoio/hugo/issues/5239) +* Revise error handling in `getJSON` and `getCSV` [43d44652](https://github.com/gohugoio/hugo/commit/43d446522a7c09af4bf6879f93341d8ff62654d1) [@bep](https://github.com/bep) [#5076](https://github.com/gohugoio/hugo/issues/5076) +* Show error on `union` or `intersect` of uncomparable types [4f72e791](https://github.com/gohugoio/hugo/commit/4f72e79120a4f964330d10c8ebe9aceb2b5761a7) [@moorereason](https://github.com/moorereason) [#3820](https://github.com/gohugoio/hugo/issues/3820) +* Do not set RSS as Kind in RSS output [555a5612](https://github.com/gohugoio/hugo/commit/555a5612b2641075b3e1b3b7af8ce9b5aba9f200) [@bep](https://github.com/bep) [#5138](https://github.com/gohugoio/hugo/issues/5138) + + + + + + + + diff --git a/content/en/news/0.49.1-relnotes/index.md b/content/en/news/0.49.1-relnotes/index.md new file mode 100644 index 000000000..a3858a9e1 --- /dev/null +++ b/content/en/news/0.49.1-relnotes/index.md @@ -0,0 +1,22 @@ + +--- +date: 2018-10-10 +title: "Hugo 0.49.1: Bug Fix" +description: "This release fixes an issue where resources.Concat would sometimes fail." +categories: ["Releases"] +images: +- images/blog/hugo-bug-poster.png + +--- + +This is a bug-fix release with 2 related fixes. This was introduced in Hugo 0.49. The most notable error situation was that `resources.Concat` could fail in some situations. + + +* Fix handling of different interface types in Slice [e2201ef1](https://github.com/gohugoio/hugo/commit/e2201ef15fdefe257ad284b2df4ccc8f8c38fac2) [@bep](https://github.com/bep) [#5269](https://github.com/gohugoio/hugo/issues/5269) + +* Improve append in Scratch [23f48c30](https://github.com/gohugoio/hugo/commit/23f48c300cb5ffe0fe43c88464f38c68831a17ad) [@bep](https://github.com/bep) [#5275](https://github.com/gohugoio/hugo/issues/5275) + + + + + diff --git a/content/en/news/0.49.2-relnotes/index.md b/content/en/news/0.49.2-relnotes/index.md new file mode 100644 index 000000000..1d24cd624 --- /dev/null +++ b/content/en/news/0.49.2-relnotes/index.md @@ -0,0 +1,17 @@ +--- +date: 2018-10-11 +title: "Hugo 0.49.2: One Bug Fix" +description: "Fixes a type issue in append and Scratch.Add" +categories: ["Releases"] +images: +- images/blog/hugo-bug-poster.png +--- + +This fixes one regression from Hugo `0.42.1`: + +* Fix type checking in Append [2159d77f](https://github.com/gohugoio/hugo/commit/2159d77f368eb1f78e51dd94133554f88052d85f) [@bep](https://github.com/bep) [#5303](https://github.com/gohugoio/hugo/issues/5303) + + + + + diff --git a/content/en/showcase/template/index.md b/content/en/showcase/template/index.md index 4210269c8..a0d83955e 100644 --- a/content/en/showcase/template/index.md +++ b/content/en/showcase/template/index.md @@ -1,21 +1,10 @@ --- -# A suitable title for this article. title: Hugo Showcase Template - -# Set this to the current date. date: 2018-02-07 - description: "A short description of this page." - -# The URL to the site on the internet. siteURL: https://gohugo.io/ - -# Link to the site's Hugo source code if public and you can/want to share. -# Remove or leave blank if not needed/wanted. siteSource: https://github.com/gohugoio/hugoDocs - -# Add credit to the article author. Leave blank or remove if not needed/wanted. byline: "[bep](https://github.com/bep), Hugo Lead" --- @@ -25,25 +14,9 @@ Have a **notable Hugo site[^1]**? We would love to feature it in this **Showcase We would really appreciate if you could: 1. Fork https://github.com/gohugoio/hugoDocs -1. Create a copy of the [content/showcase/template](https://github.com/gohugoio/hugoDocs/tree/master/content/showcase/template) directory with a suitable name. If you now run `hugo server`, your site should show up in [http://localhost:1313/showcase/](http://localhost:1313/showcase/) and on the front page. -2. Adjust the [files](#files) and write a story about your site +2. Run `hugo new showcase/your-site` (this requires >= Hugo 0.49). This will use the archetype bundle in the [docs repo](https://github.com/gohugoio/hugoDocs/tree/master/archetypes). +3. Follow the instructions in the newly created page bundle. 3. Create a new pull request in https://github.com/gohugoio/hugoDocs/pulls -**Note:** The Showcase section uses the latest bells and whistles from Hugo, [resources](/content-management/page-resources/) with [image processing](/content-management/image-processing/), so you need a reasonable up-to-date [Hugo version](https://github.com/gohugoio/hugo/releases). -## Files - -The content of the [content/showcase/template](https://github.com/gohugoio/hugoDocs/tree/master/content/showcase/template) directory explained: - -index.md -: The main content file. Fill in required front matter metadata and write your story. I does not have to be a novel. It can even be self-promotional, but it should include Hugo in some form. - -bio.md -: A short summary of the website. Site credits (who built it) fits nicely here. - -featured-template.png -: A reasonably sized screenshot of your website. It can be named anything, but the name must start with "featured". The sample image is `1500x750` (2:1 aspect ratio). - - - -[^1]: We want this to show Hugo in its best light, so this is not for the average Hugo blog. In most cases the answer to "Is my site [notabable](http://www.dictionary.com/browse/notable)?" will be obvious, but if in doubt, create an [issue](https://github.com/gohugoio/hugoDocs/issues) with a link and some words, and we can discuss it. But if you have a site with an interesting Hugo story or a company site where the company itself is notable, you are most welcome. +[^1]: We want this to show Hugo in its best light, so this is not for the average Hugo blog. In most cases the answer to "Is my site [notable](http://www.dictionary.com/browse/notable)?" will be obvious, but if in doubt, create an [issue](https://github.com/gohugoio/hugoDocs/issues) with a link and some words, and we can discuss it. But if you have a site with an interesting Hugo story or a company site where the company itself is notable, you are most welcome. diff --git a/content/en/templates/internal.md b/content/en/templates/internal.md index 7fbfec43c..fdec63c57 100644 --- a/content/en/templates/internal.md +++ b/content/en/templates/internal.md @@ -50,6 +50,8 @@ You can then include the Google Analytics internal template: {{ template "_internal/google_analytics_async.html" . }} ``` +A `.Site.GoogleAnalytics` variable is also exposed from the config. + ## Disqus Hugo also ships with an internal template for [Disqus comments][disqus], a popular commenting system for both static and dynamic websites. In order to effectively use Disqus, you will need to secure a Disqus "shortname" by [signing up for the free service][disqussignup]. @@ -76,6 +78,8 @@ To add Disqus, include the following line in templates where you want your comme {{ template "_internal/disqus.html" . }} ``` +A `.Site.DisqusShortname` variable is also exposed from the config. + ### Conditional Loading of Disqus Comments Users have noticed that enabling Disqus comments when running the Hugo web server on `localhost` (i.e. via `hugo server`) causes the creation of unwanted discussions on the associated Disqus account. @@ -110,6 +114,85 @@ You can then render your custom Disqus partial template as follows: {{ partial "disqus.html" . }} ``` +## Open Graph +An internal template for the [Open Graph protocol](http://ogp.me/), metadata that enables a page to become a rich object in a social graph. +This format is used for Facebook and some other sites. + +### Configure Open Graph + +Hugo's Open Graph template is configured using a mix of configuration variables and [front-matter](/content-management/front-matter/) on individual pages. + +{{< code-toggle file="config" >}} +[params] + title = "My cool site" + images = ["site-feature-image.jpg"] + description = "Text about my cool site" +[taxonomies] + series = "series" +{{}} + +{{< code-toggle file="content/blog/my-post" >}} +title = "Post title" +description = "Text about this post" +date = "2006-01-02" +images = ["post-cover.png"] +audio = [] +video = [] +series = [] +tags = [] +{{}} + +Hugo uses the page title and description for the title and description metadata. +The first 6 URLs from the `images` array are used for image metadata. + +Various optional metadata can also be set: +- Date, published date, and last modified data are used to set the published time metadata if specified. +- `audio` and `video` are URL arrays like `images` for the audio and video metadata tags, respectively. +- The first 6 `tags` on the page are used for the tags metadata. +- The `series` taxonomy is used to specify related "see also" pages by placing them in the same series. + +### Use the Open Graph Template + +To add Open Graph metadata, include the following line between the `` tags in your templates: + +``` +{{ template "_internal/opengraph.html" . }} +``` + +## Twitter Cards +An internal template for [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards), +metadata used to attach rich media to Tweets linking to your site. + +### Configure Twitter Cards + +Hugo's Twitter Card template is configured using a mix of configuration variables and [front-matter](/content-management/front-matter/) on individual pages. + +{{< code-toggle file="config" >}} +[params] + images = ["site-feature-image.jpg"] + description = "Text about my cool site" +{{}} + +{{< code-toggle file="content/blog/my-post" >}} +title = "Post title" +description = "Text about this post" +images = ["post-cover.png"] +{{}} + +If `images` aren't specified in the page front-matter, then hugo searches for [image page resources](/content-management/image-processing/) with `feature`, `cover`, or `thumbnail` in their name. +If no image resources with those names are found, the images defined in the [site config](getting-started/configuration/) are used instead. +If no images are found at all, then an image-less Twitter `summary` card is used instead of `summary_large_image`. + +Hugo uses the page title and description for the card's title and description fields. The page summary is used if no description is given. + +### Use the Twitter Cards Template + +To add Twitter card metadata, include the following line between the `` tags in your templates: + +``` +{{ template "_internal/twitter_cards.html" . }} +``` + ## The Internal Templates * `_internal/disqus.html` diff --git a/content/en/templates/output-formats.md b/content/en/templates/output-formats.md index ff286c9d2..37c48b75e 100644 --- a/content/en/templates/output-formats.md +++ b/content/en/templates/output-formats.md @@ -143,7 +143,7 @@ This can be changed by defining an `outputs` list of output formats in either the `Page` front matter or in the site configuration (either for all sites or per language). -Example from site config file`: +Example from site config file: {{< code-toggle file="config" >}} [outputs] diff --git a/content/en/templates/shortcode-templates.md b/content/en/templates/shortcode-templates.md index 67e54089f..ce58c686e 100644 --- a/content/en/templates/shortcode-templates.md +++ b/content/en/templates/shortcode-templates.md @@ -34,6 +34,14 @@ Hugo's built-in shortcodes cover many common, but not all, use cases. Luckily, H To create a shortcode, place an HTML template in the `layouts/shortcodes` directory of your [source organization][]. Consider the file name carefully since the shortcode name will mirror that of the file but without the `.html` extension. For example, `layouts/shortcodes/myshortcode.html` will be called with either `{{}}` or `{{%/* myshortcode /*/%}}` depending on the type of parameters you choose. +You can organize your shortcodes in subfolders, e.g. in `layouts/shortcodes/boxes`. These shortcodes would then be accessible with their relative path, e.g: + +``` +{{< boxes/square >}} +``` + +Note the forward slash. + ### Shortcode Template Lookup Order Shortcode templates have a simple [lookup order][]: @@ -71,6 +79,12 @@ To access a parameter by position, use the `.Get` followed by a numeric position {{ .Get 0 }} ``` +For the second position, you would just use: + +``` +{{ .Get 1 }} +``` + `with` is great when the output depends on a parameter being set: ``` diff --git a/content/en/tools/frontends.md b/content/en/tools/frontends.md index f41751b49..1cdc18e7c 100644 --- a/content/en/tools/frontends.md +++ b/content/en/tools/frontends.md @@ -22,6 +22,7 @@ toc: false * [caddy-hugo](https://github.com/hacdias/caddy-hugo). `caddy-hugo` is an add-on for [Caddy](https://caddyserver.com/) that delivers a good UI to edit the content of your Hugo website. * [Lipi](https://github.com/SohanChy/Lipi). Lipi is a native GUI frontend written in Java to manage your Hugo websites. * [Netlify CMS](https://netlifycms.org). Netlify CMS is an open source, serverless solution for managing Git based content in static sites, and it works on any platform that can host static sites. A [Hugo/Netlify CMS starter](https://github.com/netlify-templates/one-click-hugo-cms) is available to get new projects running quickly. +* [Hokus CMS](https://www.hokus.io). Hokus CMS is an open source, multiplatform, easy to use, desktop application for Hugo. Build from simple to complex user interfaces for Hugo websites by choosing from a dozen ready-to-use components — all for free, with no vendor lock-in. ## Commercial Services diff --git a/content/en/tools/search.md b/content/en/tools/search.md index 2145c187c..93f330a28 100644 --- a/content/en/tools/search.md +++ b/content/en/tools/search.md @@ -21,10 +21,11 @@ toc: true A static website with a dynamic search function? Yes. As alternatives to embeddable scripts from Google or other search engines, you can provide your visitors a custom search by indexing your content files directly. * [GitHub Gist for Hugo Workflow](https://gist.github.com/sebz/efddfc8fdcb6b480f567). This gist contains a simple workflow to create a search index for your static website. It uses a simple Grunt script to index all your content files and [lunr.js](http://lunrjs.com/) to serve the search results. +* [hugo-elasticsearch](https://www.npmjs.com/package/hugo-elasticsearch). Generate [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) indexes for Hugo static sites by parsing front matter. Hugo-Elasticsearch will generate a newline delimited JSON (NDJSON) file that can be bulk uploaded into Elasticsearch using any one of the available [clients](https://www.elastic.co/guide/en/elasticsearch/client/index.html). * [hugo-lunr](https://www.npmjs.com/package/hugo-lunr). A simple way to add site search to your static Hugo site using [lunr.js](http://lunrjs.com/). Hugo-lunr will create an index file of any html and markdown documents in your Hugo project. * [hugo-lunr-zh](https://www.npmjs.com/package/hugo-lunr-zh). A bit like Hugo-lunr, but Hugo-lunr-zh can help you separate the Chinese keywords. * [Github Gist for Fuse.js integration](https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae). This gist demonstrates how to leverage Hugo's existing build time processing to generate a searchable JSON index used by [Fuse.js](http://fusejs.io/) on the client side. Although this gist uses Fuse.js for fuzzy matching, any client side search tool capable of reading JSON indexes will work. Does not require npm, grunt or other build-time tools except Hugo! -* [hugo-search-index](https://www.npmjs.com/package/hugo-search-index). A library containing Gulp tasks and a prebuilt browser script that implements search. Gulp generates a search index from project markdown files. +* [hugo-search-index](https://www.npmjs.com/package/hugo-search-index). A library containing Gulp tasks and a prebuilt browser script that implements search. Gulp generates a search index from project markdown files. ## Commercial Search Services diff --git a/content/en/troubleshooting/faq.md b/content/en/troubleshooting/faq.md index 392d7a8df..4cf248eac 100644 --- a/content/en/troubleshooting/faq.md +++ b/content/en/troubleshooting/faq.md @@ -17,6 +17,10 @@ aliases: [/faq/] **Note:** The answers/solutions presented below are short, and may not be note be enough to solve your problem. Visit [Hugo Discourse](https://discourse.gohugo.io/) and use the search. It that does not help, start a new topic and ask your questions. {{% /note %}} +## I can't see my content! + +Is your markdown file [in draft mode](https://gohugo.io/content-management/front-matter/#front-matter-variables)? When testing, run `hugo server` with the `-D` or `--buildDrafts` [switch](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content). + ## Can I set configuration variables via OS environment? Yes you can! See [Configure with Environment Variables](/getting-started/configuration/#configure-with-environment-variables). diff --git a/content/en/variables/page.md b/content/en/variables/page.md index 7be94a67b..95c75dec8 100644 --- a/content/en/variables/page.md +++ b/content/en/variables/page.md @@ -96,11 +96,14 @@ See also `.ExpiryDate`, `.Date`, `.PublishDate`, and [`.GitInfo`][gitinfo]. .LinkTitle : access when creating links to the content. If set, Hugo will use the `linktitle` from the front matter before `title`. -.Next -: pointer to the following content (based on the `publishdate` field in front matter). +.Next (deprecated) +: In older Hugo versions this pointer went the wrong direction. Please use `.PrevPage` instead. + +.NextPage +: Pointer to the next [regular page](/variables/site/#site-pages) (sorted by Hugo's [default sort](/templates/lists#default-weight-date-linktitle-filepath)). Example: `{{if .NextPage}}{{.NextPage.Permalink}}{{end}}`. .NextInSection -: pointer to the following content within the same section (based on `publishdate` field in front matter). +: Pointer to the next [regular page](/variables/site/#site-pages) within the same section. Pages are sorted by Hugo's [default sort](/templates/lists#default-weight-date-linktitle-filepath). Example: `{{if .NextInSection}}{{.NextInSection.Permalink}}{{end}}`. .OutputFormats : contains all formats, including the current format, for a given page. Can be combined the with [`.Get` function](/functions/get/) to grab a specific format. (See [Output Formats](/templates/output-formats/).) @@ -118,11 +121,14 @@ See also `.ExpiryDate`, `.Date`, `.PublishDate`, and [`.GitInfo`][gitinfo]. .PlainWords : the Page content stripped of HTML as a `[]string` using Go's [`strings.Fields`](https://golang.org/pkg/strings/#Fields) to split `.Plain` into a slice. -.Prev -: Pointer to the previous content (based on `publishdate` in front matter). +.Prev (deprecated) +: In older Hugo versions this pointer went the wrong direction. Please use `.NextPage` instead. + +.PrevPage +: Pointer to the previous [regular page](/variables/site/#site-pages) (sorted by Hugo's [default sort](/templates/lists#default-weight-date-linktitle-filepath)). Example: `{{if .PrevPage}}{{.PrevPage.Permalink}}{{end}}`. .PrevInSection -: Pointer to the previous content within the same section (based on `publishdate` in front matter). For example, `{{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}`. +: Pointer to the previous [regular page](/variables/site/#site-pages) within the same section. Pages are sorted by Hugo's [default sort](/templates/lists#default-weight-date-linktitle-filepath). Example: `{{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}`. .PublishDate : the date on which the content was or will be published; `.Publishdate` pulls from the `publishdate` field in a content's front matter. See also `.ExpiryDate`, `.Date`, and `.Lastmod`. diff --git a/netlify.toml b/netlify.toml index 86d67ce08..42d2eb0c5 100644 --- a/netlify.toml +++ b/netlify.toml @@ -3,7 +3,7 @@ publish = "public" command = "hugo" [context.production.environment] -HUGO_VERSION = "0.48" +HUGO_VERSION = "0.49.2" HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" @@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true" command = "hugo --enableGitInfo" [context.split1.environment] -HUGO_VERSION = "0.48" +HUGO_VERSION = "0.49.2" HUGO_ENV = "production" [context.deploy-preview] command = "hugo --buildFuture -b $DEPLOY_PRIME_URL" [context.deploy-preview.environment] -HUGO_VERSION = "0.48" +HUGO_VERSION = "0.49.2" [context.branch-deploy] command = "hugo -b $DEPLOY_PRIME_URL" [context.branch-deploy.environment] -HUGO_VERSION = "0.48" +HUGO_VERSION = "0.49.2" [context.next.environment] HUGO_ENABLEGITINFO = "true" diff --git a/resources/_gen/images/news/0.49-relnotes/featured-hugo-49-poster_hud9cdb0f9aa2ec95d28fc3f49c81e7940_66352_480x0_resize_catmullrom_2.png b/resources/_gen/images/news/0.49-relnotes/featured-hugo-49-poster_hud9cdb0f9aa2ec95d28fc3f49c81e7940_66352_480x0_resize_catmullrom_2.png new file mode 100644 index 000000000..2d9179ad9 Binary files /dev/null and b/resources/_gen/images/news/0.49-relnotes/featured-hugo-49-poster_hud9cdb0f9aa2ec95d28fc3f49c81e7940_66352_480x0_resize_catmullrom_2.png differ diff --git a/resources/_gen/images/news/0.49-relnotes/featured-hugo-49-poster_hud9cdb0f9aa2ec95d28fc3f49c81e7940_66352_640x0_resize_catmullrom_2.png b/resources/_gen/images/news/0.49-relnotes/featured-hugo-49-poster_hud9cdb0f9aa2ec95d28fc3f49c81e7940_66352_640x0_resize_catmullrom_2.png new file mode 100644 index 000000000..e4f918db7 Binary files /dev/null and b/resources/_gen/images/news/0.49-relnotes/featured-hugo-49-poster_hud9cdb0f9aa2ec95d28fc3f49c81e7940_66352_640x0_resize_catmullrom_2.png differ