diff --git a/docs/config.toml b/docs/config.toml index 63d9cef15..12398be26 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -34,7 +34,6 @@ section = [ "HTML", "RSS"] [mediaTypes] [mediaTypes."text/netlify"] -suffix = "" delimiter = "" [outputFormats] diff --git a/docs/content/en/about/new-in-032/index.md b/docs/content/en/about/new-in-032/index.md index b8ca6430e..5ae688fc6 100644 --- a/docs/content/en/about/new-in-032/index.md +++ b/docs/content/en/about/new-in-032/index.md @@ -24,7 +24,7 @@ This documentation belongs in other places in this documentation site, but is pu Also see this demo project from [bep](https://github.com/bep/), the clever Norwegian behind these new features: -* http://hugotest.bep.is/ +* https://temp.bep.is/hugotest/ * https://github.com/bep/hugotest (source) ## Page Resources diff --git a/docs/content/en/about/what-is-hugo.md b/docs/content/en/about/what-is-hugo.md index 2c7339f7c..de7344866 100644 --- a/docs/content/en/about/what-is-hugo.md +++ b/docs/content/en/about/what-is-hugo.md @@ -43,27 +43,23 @@ Hugo is for people building a blog, a company site, a portfolio site, documentat [@spf13]: https://twitter.com/@spf13 [Aerobatic]: https://www.aerobatic.com/ -[Amazon S3]: http://aws.amazon.com/s3/ +[Amazon S3]: https://aws.amazon.com/s3/ [Azure]: https://blogs.msdn.microsoft.com/acoat/2016/01/28/publish-a-static-web-site-using-azure-web-apps/ -[CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront" -[contributing to it]: https://github.com/gohugoio/hugo -[DreamHost]: http://www.dreamhost.com/ +[CloudFront]: https://aws.amazon.com/cloudfront/ "Amazon CloudFront" +[DreamHost]: https://www.dreamhost.com/ [Firebase]: https://firebase.google.com/docs/hosting/ "Firebase static hosting" [GitHub Pages]: https://pages.github.com/ [GitLab Pages]: https://about.gitlab.com/features/pages/ [Go language]: https://golang.org/ [GoDaddy]: https://www.godaddy.com/ "Godaddy.com Hosting" -[Google Cloud Storage]: http://cloud.google.com/storage/ +[Google Cloud Storage]: https://cloud.google.com/storage/ [Heroku]: https://www.heroku.com/ -[Jekyll]: http://jekyllrb.com/ [Jekyll]: https://jekyllrb.com/ [Middleman]: https://middlemanapp.com/ -[Middleman]: https://middlemanapp.com/ -[Nanoc]: http://nanoc.ws/ [Nanoc]: https://nanoc.ws/ [Netlify]: https://netlify.com +[Rackspace]: https://www.rackspace.com/cloud/files +[Surge]: https://surge.sh +[contributing to it]: https://github.com/gohugoio/hugo [rackspace]: https://www.rackspace.com/cloud/files [static site generator]: /about/benefits/ -[Rackspace]: https://www.rackspace.com/cloud/files -[static site generator]: /about/benefits/ -[Surge]: https://surge.sh diff --git a/docs/content/en/content-management/authors.md b/docs/content/en/content-management/authors.md index afc94fa62..530557ac0 100644 --- a/docs/content/en/content-management/authors.md +++ b/docs/content/en/content-management/authors.md @@ -170,7 +170,7 @@ Last but not least, we have to create the second list that contains all publicat The layout for this page can be defined in the template `layouts/taxonomy/author.html`. {{< code file="layouts/taxonomy/author.html" download="author.html" >}} -{{ range .Data.Pages }} +{{ range .Pages }}

{{ .Title }}

written by {{ .Author.DisplayName }} {{ .Summary }} diff --git a/docs/content/en/content-management/menus.md b/docs/content/en/content-management/menus.md index c2eadf50f..4278b03be 100644 --- a/docs/content/en/content-management/menus.md +++ b/docs/content/en/content-management/menus.md @@ -36,47 +36,7 @@ A **menu** is a named array of menu entries accessible by name via the [`.Site.M If you make use of the [multilingual feature](/content-management/multilingual/), you can define language-independent menus. {{% /note %}} -A menu entry has the following properties (i.e., variables) available to it: - -`.URL` -: string - -`.Name` -: string - -`.Menu` -: string - -`.Identifier` -: string - -`.Pre` -: template.HTML - -`.Post` -: template.HTML - -`.Weight` -: int - -`.Parent` -: string - -`.Children` -: Menu - -Note that menus also have the following functions available as well: - -`.HasChildren` -: boolean - -Additionally, there are some relevant functions available to menus on a page: - -`.IsMenuCurrent` -: (menu string, menuEntry *MenuEntry ) boolean - -`.HasMenuCurrent` -: (menu string, menuEntry *MenuEntry) boolean +See the [Menu Entry Properties][me-props] for all the variables and functions related to a menu entry. ## Add content to menus @@ -139,7 +99,7 @@ The URLs must be relative to the context root. If the `baseURL` is `https://exam {{% /note %}} ## Nesting - + All nesting of content is done via the `parent` field. The parent of an entry should be the identifier of another entry. The identifier should be unique (within a menu). @@ -159,3 +119,4 @@ See [Menu Templates](/templates/menu-templates/) for information on how to rende [config]: /getting-started/configuration/ [multilingual]: /content-management/multilingual/ [sitevars]: /variables/ +[me-props]: /variables/menus/ diff --git a/docs/content/en/content-management/related.md b/docs/content/en/content-management/related.md index 5755676c3..9a4c77d40 100644 --- a/docs/content/en/content-management/related.md +++ b/docs/content/en/content-management/related.md @@ -39,7 +39,7 @@ To list up to 5 related pages is as simple as including something similar to thi Read [this blog article](https://regisphilibert.com/blog/2018/04/hugo-optmized-relashionships-with-related-content/) for a great explanation of more advanced usage of this feature. {{% /note %}} -The full set of methods available on the page lists can bee seen in this Go interface: +The full set of methods available on the page lists can be seen in this Go interface: ```go // A PageGenealogist finds related pages in a page collection. This interface is implemented diff --git a/docs/content/en/content-management/shortcodes.md b/docs/content/en/content-management/shortcodes.md index 0116078f4..35305764c 100644 --- a/docs/content/en/content-management/shortcodes.md +++ b/docs/content/en/content-management/shortcodes.md @@ -178,7 +178,7 @@ This shortcode will convert the source code provided into syntax-highlighted HTM

{{ .Title }}

- {{ range .Data.Pages }} + {{ range .Pages }} {{ .Render "summary"}} {{ end }}
@@ -194,7 +194,7 @@ The `highlight` shortcode example above would produce the following HTML when th <section id="main"> <div> <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} + {{ range .Pages }} {{ .Render "summary"}} {{ end }} </div> diff --git a/docs/content/en/content-management/static-files.md b/docs/content/en/content-management/static-files.md index fe5ea77e0..8967f5983 100644 --- a/docs/content/en/content-management/static-files.md +++ b/docs/content/en/content-management/static-files.md @@ -1,6 +1,6 @@ --- title: Static Files -description: "The `static` folder is where you place all your **static files**." +description: "Files that get served **statically** (as-is, no modification) on the site root." date: 2017-11-18 categories: [content management] keywords: [source, directories] @@ -13,36 +13,58 @@ aliases: [/static-files] toc: true --- -The `static` folder is where you place all your **static files**, e.g. stylesheets, JavaScript, images etc. +By default, the `static/` directory in the site project is used for +all **static files** (e.g. stylesheets, JavaScript, images). -You can set the name of the static folder to use in your configuration file. From **Hugo 0.31** you can configure as many static directories as you need. All the files in all the static directories will form a union filesystem. +Hugo can be configured to look into a different directory, or even +**multiple directories** for such static files by configuring the +`staticDir` parameter in the [site config][]. All the files in all the +static directories will form a union filesystem. -Example: +This union filesystem will be served from your site root. So a file +`/static/me.png` will be accessible as +`/me.png`. + +Here's an example of setting `staticDir` and `staticDir2` for a +multi-language site: {{< code-toggle copy="false" file="config" >}} staticDir = ["static1", "static2"] -[languages] -[languages.no] -staticDir = ["staticDir_override", "static_no"] -baseURL = "https://example.no" -languageName = "Norsk" -weight = 1 -title = "På norsk" +[languages] [languages.en] staticDir2 = "static_en" baseURL = "https://example.com" languageName = "English" weight = 2 title = "In English" +[languages.no] +staticDir = ["staticDir_override", "static_no"] +baseURL = "https://example.no" +languageName = "Norsk" +weight = 1 +title = "På norsk" {{}} In the above, with no theme used: -* The English site will get its static files as a union of "static1", "static2" and "static_en". On file duplicates, the right-most version will win. -* The Norwegian site will get its static files as a union of "staticDir_override" and "static_no". +- The English site will get its static files as a union of "static1", + "static2" and "static_en". On file duplicates, the right-most + version will win. +- The Norwegian site will get its static files as a union of + "staticDir_override" and "static_no". -**Note:** The `2` `static2` (can be a number between 0 and 10) is added to tell Hugo that you want to **add** this directory to the global set of static directories. Using `staticDir` on the language level would replace the global value. +Note 1 +: The **2** (can be a number between 0 and 10) in `staticDir2` is + added to tell Hugo that you want to **add** this directory to the + global set of static directories defined using `staticDir`. Using + `staticDir` on the language level would replace the global value (as + can be seen in the Norwegian site case). + +Note 2 +: The example above is a [multihost setup][]. In a regular setup, all + the static directories will be available to all sites. -**Note:** The example above is a [multihost setup](/content-management/multilingual/#configure-multilingual-multihost). In a regular setup, all the static directories will be available to all sites. +[site config]: /getting-started/configuration/#all-configuration-settings +[multihost setup]: /content-management/multilingual/#configure-multilingual-multihost diff --git a/docs/content/en/content-management/summaries.md b/docs/content/en/content-management/summaries.md index 1c341400e..0f8939377 100644 --- a/docs/content/en/content-management/summaries.md +++ b/docs/content/en/content-management/summaries.md @@ -1,7 +1,7 @@ --- title: Content Summaries linktitle: Summaries -description: Hugo generates summaries of your content. +description: Hugo generates summaries of your content. date: 2017-01-10 publishdate: 2017-01-10 lastmod: 2017-01-10 @@ -57,7 +57,7 @@ Be careful to enter <!--more--> exactly You can show content summaries with the following code. You could use the following snippet, for example, in a [section template][]. {{< code file="page-list-with-summaries.html" >}} -{{ range first 10 .Data.Pages }} +{{ range first 10 .Pages }}
@@ -78,4 +78,4 @@ Note how the `.Truncated` boolean valuable may be used to hide the "Read More... [org]: /content-management/formats/ [pagevariables]: /variables/page/ -[section template]: /templates/section-templates/ \ No newline at end of file +[section template]: /templates/section-templates/ diff --git a/docs/content/en/content-management/syntax-highlighting.md b/docs/content/en/content-management/syntax-highlighting.md index 4576624d0..841ecbd3d 100644 --- a/docs/content/en/content-management/syntax-highlighting.md +++ b/docs/content/en/content-management/syntax-highlighting.md @@ -134,7 +134,7 @@ Highlighting is carried out via the [built-in shortcode](/content-management/sho

{{ .Title }}

- {{ range .Data.Pages }} + {{ range .Pages }} {{ .Render "summary"}} {{ end }}
@@ -157,7 +157,7 @@ It is also possible to add syntax highlighting with GitHub flavored code fences.

{{ .Title }}

- {{ range .Data.Pages }} + {{ range .Pages }} {{ .Render "summary"}} {{ end }}
diff --git a/docs/content/en/functions/after.md b/docs/content/en/functions/after.md index f01ba1436..d627f792a 100644 --- a/docs/content/en/functions/after.md +++ b/docs/content/en/functions/after.md @@ -39,7 +39,7 @@ You can use `after` in combination with the [`first` function][] and Hugo's [pow {{ define "main" }}

Featured Article

- {{ range first 1 .Data.Pages.ByPublishDate.Reverse }} + {{ range first 1 .Pages.ByPublishDate.Reverse }}

{{.Title}}

@@ -48,7 +48,7 @@ You can use `after` in combination with the [`first` function][] and Hugo's [pow

Recent Articles

- {{ range first 3 (after 1 .Data.Pages.ByPublishDate.Reverse) }} + {{ range first 3 (after 1 .Pages.ByPublishDate.Reverse) }}

{{.Title}}

diff --git a/docs/content/en/functions/first.md b/docs/content/en/functions/first.md index 29ba3ac1c..464dfa671 100644 --- a/docs/content/en/functions/first.md +++ b/docs/content/en/functions/first.md @@ -21,8 +21,7 @@ aliases: [] ``` -{{ range first 10 .Data.Pages }} +{{ range first 10 .Pages }} {{ .Render "summary" }} {{ end }} ``` - diff --git a/docs/content/en/functions/hasmenucurrent.md b/docs/content/en/functions/hasmenucurrent.md index eac41103e..c7b8eb7a9 100644 --- a/docs/content/en/functions/hasmenucurrent.md +++ b/docs/content/en/functions/hasmenucurrent.md @@ -10,14 +10,18 @@ menu: docs: parent: "functions" keywords: [menus] -signature: ["HasMenuCurrent"] +signature: ["PAGE.HasMenuCurrent MENU MENUENTRY"] workson: [menus] hugoversion: -relatedfuncs: [] +relatedfuncs: ["IsMenuCurrent"] deprecated: false toc: false -draft: true +draft: false aliases: [] --- -Used in [menu templates](/templates/menu-templates/). +`.HasMenuCurrent` is a method in `Page` object returning a _boolean_ value. It +returns `true` if the PAGE is the same object as the `.Page` in one of the +**children menu entries** under MENUENTRY in a given MENU. + +You can find its example use in [menu templates](/templates/menu-templates/). diff --git a/docs/content/en/functions/ismenucurrent.md b/docs/content/en/functions/ismenucurrent.md index 647dcdcf0..66c7197a2 100644 --- a/docs/content/en/functions/ismenucurrent.md +++ b/docs/content/en/functions/ismenucurrent.md @@ -10,14 +10,18 @@ menu: docs: parent: "functions" keywords: [menus] -signature: ["IsMenuCurrent"] +signature: ["PAGE.IsMenuCurrent MENU MENUENTRY"] workson: [menus] hugoversion: -relatedfuncs: [] +relatedfuncs: ["HasMenuCurrent"] deprecated: false -draft: true +draft: false aliases: [] needsexample: true --- -Used in [menu templates](/templates/menu-templates/). +`.IsMenuCurrent` is a method in `Page` object returning a _boolean_ value. It +returns `true` if the PAGE is the same object as the `.Page` in MENUENTRY in a +given MENU. + +You can find its example use in [menu templates](/templates/menu-templates/). diff --git a/docs/content/en/functions/last.md b/docs/content/en/functions/last.md index ea633837b..f992b980a 100644 --- a/docs/content/en/functions/last.md +++ b/docs/content/en/functions/last.md @@ -23,8 +23,7 @@ aliases: [] ``` -{{ range last 10 .Data.Pages }} +{{ range last 10 .Pages }} {{ .Render "summary" }} {{ end }} ``` - diff --git a/docs/content/en/functions/render.md b/docs/content/en/functions/render.md index a4abfa81d..c76af39fe 100644 --- a/docs/content/en/functions/render.md +++ b/docs/content/en/functions/render.md @@ -26,7 +26,7 @@ This function is only available when applied to a single piece of content within This example could render a piece of content using the content view located at `/layouts/_default/summary.html`: ``` -{{ range .Data.Pages }} +{{ range .Pages }} {{ .Render "summary"}} {{ end }} ``` diff --git a/docs/content/en/functions/scratch.md b/docs/content/en/functions/scratch.md index 93a1e426a..c0ecaca80 100644 --- a/docs/content/en/functions/scratch.md +++ b/docs/content/en/functions/scratch.md @@ -33,11 +33,19 @@ See [this Go issue](https://github.com/golang/go/issues/10608) for the main moti For a detailed analysis of `.Scratch` and in context use cases, see this [post](https://regisphilibert.com/blog/2017/04/hugo-scratch-explained-variable/). {{% /note %}} -## Methods +## Get a Scratch -`Scratch` is added to both `Page` and `Shortcode` -- with following methods: +From Hugo `0.43` you can also create a locally scoped `Scratch` by calling `newScratch`: + +```go-html-template +$scratch := newScratch +$scratch.Set "greeting" "Hello" +``` + +A `Scratch` is also added to both `Page` and `Shortcode`. `Sratch` have the following methods: #### .Set + Set the given value to a given key ```go-html-template diff --git a/docs/content/en/functions/where.md b/docs/content/en/functions/where.md index eb3111215..9ad8daf2a 100644 --- a/docs/content/en/functions/where.md +++ b/docs/content/en/functions/where.md @@ -23,7 +23,7 @@ needsexample: true `where` filters an array to only the elements containing a matching value for a given field. ```go-html-template -{{ range where .Data.Pages "Section" "post" }} +{{ range where .Pages "Section" "post" }} {{ .Content }} {{ end }} ``` @@ -45,7 +45,7 @@ series: golang It can also be used with the logical operators `!=`, `>=`, `in`, etc. Without an operator, `where` compares a given field with a matching value equivalent to `=`. ```go-html-template -{{ range where .Data.Pages "Section" "!=" "post" }} +{{ range where .Pages "Section" "!=" "post" }} {{ .Content }} {{ end }} ``` @@ -104,7 +104,7 @@ You can also put the returned value of the `where` clauses into a variable: The following grabs the first five content files in `post` using the [default ordering](/templates/lists/) for lists (i.e., `weight => date`): {{< code file="where-with-first.html" >}} -{{ range first 5 (where .Data.Pages "Section" "post") }} +{{ range first 5 (where .Pages "Section" "post") }} {{ .Content }} {{ end }} {{< /code >}} @@ -114,7 +114,7 @@ The following grabs the first five content files in `post` using the [default or You can also nest `where` clauses to drill down on lists of content by more than one parameter. The following first grabs all pages in the "blog" section and then ranges through the result of the first `where` clause and finds all pages that are *not* featured: ```go-html-template -{{ range where (where .Data.Pages "Section" "blog" ) ".Params.featured" "!=" "true" }} +{{ range where (where .Pages "Section" "blog" ) ".Params.featured" "!=" "true" }} ``` ## Unset Fields @@ -129,7 +129,7 @@ Only the following operators are available for `nil` * `!=`, `<>`, `ne`: True if the given field is set. ```go-html-template -{{ range where .Data.Pages ".Params.specialpost" "!=" nil }} +{{ range where .Pages ".Params.specialpost" "!=" nil }} {{ .Content }} {{ end }} ``` diff --git a/docs/content/en/getting-started/configuration.md b/docs/content/en/getting-started/configuration.md index ea21fa5ce..7b0ca2a01 100644 --- a/docs/content/en/getting-started/configuration.md +++ b/docs/content/en/getting-started/configuration.md @@ -193,7 +193,7 @@ sitemap : Default [sitemap configuration](/templates/sitemap-template/#configure-sitemap-xml). staticDir ("static") -: Relative directory from where Hugo reads static files. +: A directory or a list of directories from where Hugo reads [static files][static-files]. stepAnalysis (false) : Display memory and timing of different steps of the program. @@ -405,3 +405,4 @@ Hugo v0.20 introduced the ability to render your content to multiple output form [templates]: /templates/ [toml]: https://github.com/toml-lang/toml [yaml]: http://yaml.org/spec/ +[static-files]: /content-management/static-files/ diff --git a/docs/content/en/getting-started/installing.md b/docs/content/en/getting-started/installing.md index 7a81d097c..a4cf0801f 100644 --- a/docs/content/en/getting-started/installing.md +++ b/docs/content/en/getting-started/installing.md @@ -1,7 +1,7 @@ --- title: Install Hugo linktitle: Install Hugo -description: Install Hugo on macOS, Windows, Linux, FreeBSD, and on any machine where the Go compiler tool chain can run. +description: Install Hugo on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine where the Go compiler tool chain can run. date: 2016-11-01 publishdate: 2016-11-01 lastmod: 2018-01-02 @@ -31,6 +31,7 @@ Hugo currently provides pre-built binaries for the following: * macOS (Darwin) for x64, i386, and ARM architectures * Windows * Linux +* OpenBSD * FreeBSD Hugo may also be compiled from source wherever the Go compiler tool chain can run; e.g., on other operating systems such as DragonFly BSD, OpenBSD, Plan 9, Solaris, and others. See for the full set of supported combinations of target operating systems and compilation architectures. @@ -451,7 +452,7 @@ Hugo-as-a-snap can write only inside the user’s `$HOME` directory---and gvfs-m You can also install Hugo from the Arch Linux [community](https://www.archlinux.org/packages/community/x86_64/hugo/) repository. Applies also for derivatives such as Manjaro. ``` -sudo pacman -Sy hugo +sudo pacman -Syu hugo ``` ### Fedora @@ -468,6 +469,14 @@ sudo dnf install hugo See the [related discussion in the Hugo forums][redhatforum]. +## OpenBSD + +OpenBSD provides a package for Hugo via `pkg_add`: + +``` +doas pkg_add hugo +``` + ## Upgrade Hugo Upgrading Hugo is as easy as downloading and replacing the executable you’ve placed in your `PATH` or run `brew upgrade hugo` if using Homebrew. diff --git a/docs/content/en/news/0.30-relnotes/index.md b/docs/content/en/news/0.30-relnotes/index.md index db49a1bf3..9281a5c20 100644 --- a/docs/content/en/news/0.30-relnotes/index.md +++ b/docs/content/en/news/0.30-relnotes/index.md @@ -9,7 +9,7 @@ images: --- -Hugo `0.30` is the **Race Car Edition**. Hugo is already very very fast, but much wants more. So we added **Fast Render Mode**. It is hard to explain, so start the Hugo development server with `hugo server` and start editing. Live reloads just got so much faster! The "how and what" is discussed at length in [other places](https://github.com/gohugoio/hugo/pull/3959), but the short version is that we now re-render only the parts of the site that you are working on. +Hugo `0.30` is the **Race Car Edition**. Hugo is already very very fast, but wants much more. So we added **Fast Render Mode**. It is hard to explain, so start the Hugo development server with `hugo server` and start editing. Live reloads just got so much faster! The "how and what" is discussed at length in [other places](https://github.com/gohugoio/hugo/pull/3959), but the short version is that we now re-render only the parts of the site that you are working on. The second performance-related feature is a follow-up to the Template Metrics added in Hugo `0.29`. Now, if you add the flag `--templateMetricsHints`, we will calculate a score for how your partials can be cached (with the `partialCached` template func). diff --git a/docs/content/en/news/0.43-relnotes/featured-hugo-43-poster.png b/docs/content/en/news/0.43-relnotes/featured-hugo-43-poster.png new file mode 100644 index 000000000..b221ca7f1 Binary files /dev/null and b/docs/content/en/news/0.43-relnotes/featured-hugo-43-poster.png differ diff --git a/docs/content/en/news/0.43-relnotes/index.md b/docs/content/en/news/0.43-relnotes/index.md index 483131033..cd8515995 100644 --- a/docs/content/en/news/0.43-relnotes/index.md +++ b/docs/content/en/news/0.43-relnotes/index.md @@ -1,8 +1,8 @@ --- date: 2018-07-09 -title: "0.43" -description: "0.43" +title: "And Now: Hugo Pipes!" +description: "Hugo 0.43 adds a powerful and simple to use assets pipeline with SASS/SCSS and much, much more …" categories: ["Releases"] --- diff --git a/docs/content/en/news/0.44-relnotes/featured-hugo-44-poster.png b/docs/content/en/news/0.44-relnotes/featured-hugo-44-poster.png new file mode 100644 index 000000000..330b235fb Binary files /dev/null and b/docs/content/en/news/0.44-relnotes/featured-hugo-44-poster.png differ diff --git a/docs/content/en/news/0.44-relnotes/index.md b/docs/content/en/news/0.44-relnotes/index.md index 2725d4746..aa8396898 100644 --- a/docs/content/en/news/0.44-relnotes/index.md +++ b/docs/content/en/news/0.44-relnotes/index.md @@ -1,8 +1,8 @@ --- date: 2018-07-13 -title: "0.44" -description: "0.44" +title: "Hugo 0.44: Friday the 13th Edition" +description: "A sequel to the very popular Hugo Pipes Edition; bug-fixes and enhancements …" categories: ["Releases"] --- diff --git a/docs/content/en/news/lets-celebrate-hugos-5th-birthday/index.md b/docs/content/en/news/lets-celebrate-hugos-5th-birthday/index.md index a06d535d5..9912027b5 100644 --- a/docs/content/en/news/lets-celebrate-hugos-5th-birthday/index.md +++ b/docs/content/en/news/lets-celebrate-hugos-5th-birthday/index.md @@ -59,7 +59,7 @@ Hugo has stuck with the sub-zero versions to signal active development, with a n ### The Road to 1.0 -We have some more technical tasks that needs to be done (there is ongoing work to get the page quries into a more consistent state, also a simpler `.GetPage` method), but also some cool new functionality. The following roadmap is taken from memory, and may not be complete, but should be a good indication of what's ahead. +We have some more technical tasks that needs to be done (there is ongoing work to get the page queries into a more consistent state, also a simpler `.GetPage` method), but also some cool new functionality. The following roadmap is taken from memory, and may not be complete, but should be a good indication of what's ahead. Pages from "other data sources" : Currently, in addition to Hugo's list pages, every URL must be backed by a content file (Markdown, HTML etc.). This covers most use cases, but we need a flexible way to generate pages from other data sources. Think product catalogues and similar. @@ -67,7 +67,7 @@ Pages from "other data sources" Upgrade Blackfriday to v2 : [Blackfriday](https://github.com/russross/blackfriday) is the main content renderer in Hugo. It has been rewritten to a more flexible architecture, which should allow us to fix some of the current shortcomings. -We should be able to create a better and easier-to-use data structure from the rendered content: Summary, the content after the summary, being able to range over the footnotes and the ToC. Having ToC as a proper data structure also open up a few other potential uses; using it as an index in [Related Content](https://gohugo.io/content-management/related/) would be one example. +We should be able to create a better and easier-to-use data structure from the rendered content: Summary, the content after the summary, being able to range over the footnotes and the ToC. Having ToC as a proper data structure also opens up a few other potential uses; using it as an index in [Related Content](https://gohugo.io/content-management/related/) would be one example. This should also enable us to _do more_ with [Custom Output Formats](/templates/output-formats). It is already very powerful. GettyPubs are using it in [Quire](https://github.com/gettypubs/quire) to build [beautiful multi-platform publications](http://www.getty.edu/publications/digital/digitalpubs.html). But it can be improved. For rendering of content files, you are currently restricted to HTML. It would be great if we could configure alternative renderers per output format, such as LaTeX and EPUB. @@ -75,7 +75,7 @@ Related to this is also to add a configurable "Markdown URL rewriter", which sho ### The Road to the Future -These are the items that first comes to mind if you ask me to think even further ahead: +These are the items that first come to mind if you ask me to think even further ahead: Dependency manager for Theme Components : In Hugo `0.42` we added [Theme Components](/themes/theme-components/) and Theme Inheritance. With SCSS support in Hugo `0.43`, which also follows the same project/themes precedence order (add `_variables.scss` to your project, configure SASS colour variables in `config.toml`), we have a solid foundation for creating easy to use and extensible themes. But we are missing some infrastructure around this. We have a site with 235+ [themes](https://themes.gohugo.io/)[^themes] listed, but you currently need to do some added work to get the theme up and running for your site. In the Go world, we don't have NPM to use, which is a curse and a blessing, but I have some ideas about building a simple dependency manager into Hugo, modelled after how Go is doing it (`hugo install`). You should be able to configure what theme and theme components you want to use, and Hugo should handle the installation of the correct versions. This should make it easier for the user, but it would also enable community driven and even commercial "theme stores". @@ -90,19 +90,19 @@ The "New York Times on Hugo" Use Case : There are recurring questions on the support forum from [really big sites](https://discourse.gohugo.io/t/transition-2m-posts-from-wordpress-to-hugo/12704) that want to move to Hugo. There are many [good reasons](https://www.netlify.com/blog/2016/05/18/9-reasons-your-site-should-be-static/) why they want this (security, cost-saving, EU regulations etc.). And while there have been reports about companies building 600 000 pages with Hugo on very powerful hardware, we will have to rethink the build model to make this usable. Keywords are: streaming builds, segmented builds, partial rebuilds. There are other site generators also talking about this. It should be possible, and my instinct tells me that it should be easier to do when your starting point is "really fast". But this is not a small weekend project for me, and I have already talked to several companies about sponsoring this. Plugins -: A Theme Component could also be called a plugin. But there are several potential plugin hooks into Hugo's build pipeline: Resource transformations, content rendering etc. We will eventually get there, but we should do it without giving up too much of the Hugo speed and simplicity. +: A Theme Component could also be called a plugin. But there are several potential plugin hooks into Hugo's build pipeline: resource transformations, content rendering, etc. We will eventually get there, but we should do it without giving up too much of the Hugo speed and simplicity. ## Thanks -So, thanks to everyone who have contributed to getting Hugo where it is today. It is hard to single out individuals, but a big shout-out to all the Hugo experts and moderators helping out making the [discourse.gohugo.io](https://discourse.gohugo.io/) a very active and possibly one of the best support forums out there. +So, thanks to everyone who has contributed to getting Hugo where it is today. It is hard to single out individuals, but a big shout-out to all the Hugo experts and moderators helping out making [discourse.gohugo.io](https://discourse.gohugo.io/) a very active and possibly one of the best support forums out there. -And the last shout-out goes to two maintainers who have been there more or less from the start. [@digitalcraftsman](https://github.com/digitalcraftsman/) has been doing a fantastic job keeping the fast growing theme site and [repository](https://github.com/gohugoio/hugoThemes) in pristine condition. I have it on my watch list, but that is just out of curiosity. There are lots of activity, but it runs as clock work. [Anthony Fok](https://github.com/anthonyfok) has contributed with a variety of things but is most notable as the Linux expert on the team. He manages the Debian build and is the one to thank for up-to-date binaries on Debian and Ubuntu. +And the last shout-out goes to two maintainers who have been there more or less from the start. [@digitalcraftsman](https://github.com/digitalcraftsman/) has been doing a fantastic job keeping the fast growing theme site and [repository](https://github.com/gohugoio/hugoThemes) in pristine condition. I have it on my watch list, but that is just out of curiosity. There is lots of activity, but it runs as clock work. [Anthony Fok](https://github.com/anthonyfok) has contributed with a variety of things but is most notable as the Linux expert on the team. He manages the Debian build and is the one to thank for up-to-date binaries on Debian and Ubuntu. One final note: If you have not done so already, please visit [github.com/gohugoio/hugo](https://github.com/gohugoio/hugo) and push the "star button". Gopher artwork by [Ashley McNamara](https://github.com/ashleymcnamara/gophers/) (licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)). Inspired by [Renee French](https://reneefrench.blogspot.com/). -[^2]: Numbers from Google Analytics. The Hugo websites are https://discourse.gohugo.io/, https://gohugo.io/ and https://themes.gohugo.io/. It is rumoured that when [Matt Biilman](https://twitter.com/biilmann?lang=en), CEO and Co-founder of Netlify, opened the first power bill after sponsoring Hugo's hosting, said: "Du må lave fis med mig, those Hugo sites have lots of web traffic!" +[^2]: Numbers from Google Analytics. The Hugo websites are https://discourse.gohugo.io, https://gohugo.io and https://themes.gohugo.io. It is rumoured that when [Matt Biilman](https://twitter.com/biilmann?lang=en), CEO and Co-founder of Netlify, opened the first power bill after sponsoring Hugo's hosting, said: "Du må lave fis med mig, those Hugo sites have lots of web traffic!" [^sgen]: That was at the time of writing this article. _Next_, a React based static site generator, has momentum and is closing in on Hugo's 2nd place. -[^themes]: We pull all the themes from GitHub and build the theme site and 235 demo sites on Netlify in 4 minutes. And that is impressing. +[^themes]: We pull all the themes from GitHub and build the theme site and 235 demo sites on Netlify in 4 minutes. That is impressive. diff --git a/docs/content/en/readfiles/menuvars.md b/docs/content/en/readfiles/menuvars.md deleted file mode 100644 index 339fc108d..000000000 --- a/docs/content/en/readfiles/menuvars.md +++ /dev/null @@ -1,39 +0,0 @@ -`.URL` -: string - -`.Name` -: string - -`.Menu` -: string - -`.Identifier` -: string - -`.Pre` -: template.HTML - -`.Post` -: template.HTML - -`.Weight` -: int - -`.Parent` -: string - -`.Children` -: Menu - -Note that menus also have the following functions available as well: - -[`.HasChildren`](/functions/haschildren/) -: boolean - -Additionally, there are some relevant functions available to menus on a page: - -[`.IsMenuCurrent`](/functions/ismenucurrent/) -: (menu string, menuEntry *MenuEntry ) boolean - -[`.HasMenuCurrent`](/functions/hasmenucurrent/) -: (menu string, menuEntry *MenuEntry) boolean \ No newline at end of file diff --git a/docs/content/en/templates/404.md b/docs/content/en/templates/404.md index eaa479d29..64ebe1694 100644 --- a/docs/content/en/templates/404.md +++ b/docs/content/en/templates/404.md @@ -21,7 +21,7 @@ When using Hugo with [GitHub Pages](http://pages.github.com/), you can provide y 404 pages will have all the regular [page variables][pagevars] available to use in the templates. -In addition to the standard page variables, the 404 page has access to all site content accessible from `.Data.Pages`. +In addition to the standard page variables, the 404 page has access to all site content accessible from `.Pages`. ``` ▾ layouts/ diff --git a/docs/content/en/templates/base.md b/docs/content/en/templates/base.md index 94d4cb2ef..4948f6f35 100644 --- a/docs/content/en/templates/base.md +++ b/docs/content/en/templates/base.md @@ -90,7 +90,7 @@ From the above base template, you can define a [default list template][hugolists {{< code file="layouts/_default/list.html" download="list.html" >}} {{ define "main" }}

Posts

- {{ range .Data.Pages }} + {{ range .Pages }}

{{ .Title }}

{{ .Content }} diff --git a/docs/content/en/templates/homepage.md b/docs/content/en/templates/homepage.md index 833664866..48130c39b 100644 --- a/docs/content/en/templates/homepage.md +++ b/docs/content/en/templates/homepage.md @@ -36,9 +36,9 @@ The homepage, similar to other [list pages in Hugo][lists], accepts content and See the homepage template below or [Content Organization][contentorg] for more information on the role of `_index.md` in adding content and front matter to list pages. -## `.Data.Pages` on the Homepage +## `.Pages` on the Homepage -In addition to the standard [page variables][pagevars], the homepage template has access to *all* site content via `.Data.Pages`. +In addition to the standard [page variables][pagevars], the homepage template has access to *all* site content via `.Pages`. ## Example Homepage Template @@ -58,8 +58,8 @@ The following is an example of a homepage template that uses [partial][partials] {{.Content}}
- - {{ range first 10 .Data.Pages }} + + {{ range first 10 .Pages }} {{ .Render "summary"}} {{ end }}
diff --git a/docs/content/en/templates/introduction.md b/docs/content/en/templates/introduction.md index f13378ef0..7f3a862ef 100644 --- a/docs/content/en/templates/introduction.md +++ b/docs/content/en/templates/introduction.md @@ -504,7 +504,7 @@ Go allows you to do more than what's shown here. Using Hugo's [`where` function] {{< code file="layouts/partials/upcoming-events.html" download="upcoming-events.html" >}}

Upcoming Events

    -{{ range where .Data.Pages.ByDate "Section" "events" }} +{{ range where .Pages.ByDate "Section" "events" }} {{ if ge .Date.Unix .Now.Unix }}
  • diff --git a/docs/content/en/templates/lists.md b/docs/content/en/templates/lists.md index 431407e43..2871b181e 100644 --- a/docs/content/en/templates/lists.md +++ b/docs/content/en/templates/lists.md @@ -101,7 +101,7 @@ You can now access this `_index.md`'s' content in your list template: