hugo/content/en/variables/page.md at 9aec42c5452b3eb224888c50ba1c3f3b68a447e9

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00

Bjørn Erik Pedersen 77b976dd92 Squashed 'docs/' changes from a7e1e9be8..686c7b6eb

686c7b6eb ci(Netlify): specify `HUGO_VERSION` environment variable once
da99a356f fix: change heading level
e57da3f00 Update taxonomy methods
746172490 Update description of rendered breadcrumb navigation
6bc52fd40 Clarify term
dab07dcb0 Fix typo
e50fa452a Fix typo
6c1ea83c2 Update template overview page
a5dc97845 Clarify the append function
a135e52a0 Update GitHub hosting instructions
a51bf9f4f Update sections page
ed35fc6c4 Update archetypes and glossary
1a4522b3e Format examples
a70f20094 Use "hugo new content" to create content
673846ff9 Remove comment
b7febf0c5 Fix link
6f6fe2133 Miscellaneous edits
99227dd18 Remove lookup order table from output formats page
bc8870657 tools/editors: Add Prettier Plugin for Go Templates
157b169eb Update docs.yaml
1c8f514e0 Update cond function
e5f1f8113 Add assumptions to taxonomy and term template lookup order examples
475b406e2 Update postprocess
2d6cb8dfc glossary: Update content type
03b514bac Add descriptions to template lookup order example sections
06678f919 glossary: Fix broken link
4cd505612 Simplify news listing
fadb980db Update glossary of terms
491bacd78 Change order of example sections for template lookup order
04b8f39ec Create glossary of terms
12e896bc0 Remove reference to asciidoctor-rouge extension
055f7bb37 Insert missing words
8cd6ac387 Miscellaneous edits
2cbe17f41 Update configuration.md
529615373 Update data-templates.md
853154e65 Update theme
45f08627a resources.getRemote: Fix definition list
29a51dac1 Update docshelper
3bdfe88c6 Remove link to gitter from site footer
cacd0e461 Use "map" instead of "dictionary"
704dd5da6 Document the transform.Remarshal template function
e8d744951 Populate news section via GitHub releases API
3ff1118c7 Replace docs.json with docs.yaml
7726bbcac Use docs.json to generate default config throughout the site
57dca93df Use docs.json to generate default config for related content
74d5082c7 Add some .RenderShortcodes docs
cf5ab5062 netlify: Hugo 0.117.0
420f7aa69 Add all config to docshelper.json

git-subtree-dir: docs
git-subtree-split: 686c7b6eb182ed335dc94b3a0b80c564f7658380

2023-08-30 19:23:47 +02:00

14 KiB

Raw Blame History

title

description

Page variables

.AlternativeOutputFormats: Contains all alternative formats for a given page; this variable is especially useful link rel list in your site's <head>. (See Output Formats.)
.Aliases: Aliases of this page
.Ancestors: Ancestors of this page.
.BundleType: The bundle type: leaf, branch, or an empty string if the page is not a bundle.
.Content: The content itself, defined below the front matter.
.Data: The data specific to this type of page.
.Date: The date associated with the page. By default, this is the front matter date value. See configuring dates for a description of fallback values and precedence. See also .ExpiryDate, .Lastmod, and .PublishDate.
.Description: The description for the page.
.Draft: A boolean, true if the content is marked as a draft in the front matter.
.ExpiryDate: The date on which the content is scheduled to expire. By default, this is the front matter expiryDate value. See configuring dates for a description of fallback values and precedence. See also .Date, .Lastmod, and .PublishDate.
.File: Filesystem-related data for this content file. See also File Variables.
.Fragments: Fragments returns the fragments for this page. See Page Fragments.
.FuzzyWordCount: The approximate number of words in the content.
.IsHome: true in the context of the homepage.
.IsNode: Always false for regular content pages.
.IsPage: Always true for regular content pages.
.IsSection: true if .Kind is section.
.IsTranslated: true if there are translations to display.
.Keywords: The meta keywords for the content.
.Kind: The page's kind. Possible return values are page, home, section, taxonomy, or term. Note that there are also RSS, sitemap, robotsTXT, and 404 kinds, but these are only available during the rendering of each of these respective page's kind and therefore not available in any of the Pages collections.
.Language: A language object that points to the language's definition in the site configuration. .Language.Lang gives you the language code.
.Lastmod: The date on which the content was last modified. By default, if enableGitInfo is true in your site configuration, this is the Git author date, otherwise the front matter lastmod value. See configuring dates for a description of fallback values and precedence. See also .Date,ExpiryDate, .PublishDate, and .GitInfo.
.LinkTitle: Access when creating links to the content. If set, Hugo will use the linktitle from the front matter before title.
.Next: Points up to the next regular page (sorted by Hugo's default sort). Example: {{ with .Next }}{{ .Permalink }}{{ end }}. Calling .Next from the first page returns nil.
.NextInSection: Points up to the next regular page below the same top level section (e.g. in /blog)). Pages are sorted by Hugo's default sort. Example: {{ with .NextInSection }}{{ .Permalink }}{{ end }}. Calling .NextInSection from the first page returns nil.
.OutputFormats: Contains all formats, including the current format, for a given page. Can be combined the with .Get function to grab a specific format. (See Output Formats.)
.Permalink: The Permanent link for this page; see Permalinks
.Plain: The Page content stripped of HTML tags and presented as a string. You may need to pipe the result through the htmlUnescape function when rendering this value with the HTML output format.
.PlainWords: The slice of strings that results from splitting .Plain into words, as defined in Go's strings.Fields.
.Prev: Points down to the previous regular page(sorted by Hugo's default sort). Example: {{ if .Prev }}{{ .Prev.Permalink }}{{ end }}. Calling .Prev from the last page returns nil.
.PrevInSection: Points down to the previous regular page below the same top level section (e.g. /blog). Pages are sorted by Hugo's default sort. Example: {{ if .PrevInSection }}{{ .PrevInSection.Permalink }}{{ end }}. Calling .PrevInSection from the last page returns nil.
.PublishDate: The date on which the content was or will be published. By default, this is the front matter publishDate value. See configuring dates for a description of fallback values and precedence. See also .Date, .ExpiryDate, and .Lastmod.
.RawContent: Raw markdown content without the front matter. Useful with remarkjs.com
.RenderShortcodes: See Render Shortcodes.
.ReadingTime: The estimated time, in minutes, it takes to read the content.
.Resources: Resources such as images and CSS that are associated with this page
.Ref: Returns the permalink for a given reference (e.g., .Ref "sample.md"). .Ref does not handle in-page fragments correctly. See Cross References.
.RelPermalink: The relative permanent link for this page.
.RelRef: Returns the relative permalink for a given reference (e.g., RelRef "sample.md"). .RelRef does not handle in-page fragments correctly. See Cross References.
.Site: See Site Variables.
.Sites: Returns all sites (languages). A typical use case would be to link back to the main language: <a href="{{ .Sites.First.Home.RelPermalink }}">...</a>.
.Sites.First: Returns the site for the first language. If this is not a multilingual setup, it will return itself.
.Summary: A generated summary of the content for easily showing a snippet in a summary view. The breakpoint can be set manually by inserting  at the appropriate place in the content page, or the summary can be written independent of the page text. See Content Summaries for more details.
.TableOfContents: The rendered table of contents for the page.
.Title: The title for this page.
.Translations: A list of translated versions of the current page. See Multilingual Mode for more information.
.TranslationKey: The key used to map language translations of the current page. See Multilingual Mode for more information.
.Truncated: A boolean, true if the .Summary is truncated. Useful for showing a "Read more..." link only when necessary. See Summaries for more information.
.Type: The content type of the content (e.g., posts).
.Weight: Assigned weight (in the front matter) to this content, used in sorting.
.WordCount: The number of words in the content.

Page collections

List pages receive the following page collections in context:

.Pages: Regular pages within the current section (not recursive), and section pages for immediate descendant sections (not recursive).
.RegularPages: Regular pages within the current section (not recursive).
.RegularPagesRecursive: Regular pages within the current section, and regular pages within all descendant sections.

Writable page-scoped variables

.Scratch: Returns a Scratch to store and manipulate data. In contrast to the .Store method, this scratch is reset on server rebuilds.
.Store: Returns a Scratch to store and manipulate data. In contrast to the .Scratch method, this scratch is not reset on server rebuilds.

Section variables and methods

Also see Sections.

{{< readfile file="/content/en/readfiles/sectionvars.md" markdown="true" >}}

Page fragments

The .Fragments method returns a list of fragments for the current page.

.Headings: A recursive list of headings for the current page. Can be used to generate a table of contents.

{{< todo >}}add .Headings toc example{{< /todo >}}

.Identifiers: A sorted list of identifiers for the current page. Can be used to check if a page contains a specific identifier or if a page contains duplicate identifiers:

{{ if .Fragments.Identifiers.Contains "my-identifier" }}
    <p>Page contains identifier "my-identifier"</p>
{{ end }}

{{ if gt (.Fragments.Identifiers.Count "my-identifier")  1 }}
    <p>Page contains duplicate "my-identifier" fragments</p>
{{ end }}

.HeadingsMap: Holds a map of headings for the current page. Can be used to start the table of contents from a specific heading.

Also see the Go Doc for the return type.

Fragments in hooks and shortcodes

.Fragments are safe to call from render hooks, even on the page you're on (.Page.Fragments). For shortcodes we recommend that all .Fragments usage is nested inside the {{</**/>}} shortcode delimiter ({{%/**/%}} takes part in the ToC creation so it's easy to end up in a situation where you bite yourself in the tail).

The global page function

Hugo almost always passes a Page as the data context into the top level template (e.g. single.html) (the one exception is the multihost sitemap template). This means that you can access the current page with the . variable in the template.

But when you're deeply nested inside .Render, partial etc., accessing that Page object isn't always practical or possible.

For this reason, Hugo provides a global page function that you can use to access the current page from anywhere in any template.

{{ page.Title }}

There are one caveat with this, and this isn't new, but it's worth mentioning here: There are situations in Hugo where you may see a cached value, e.g. when using partialCached or in a shortcode.

The `.RenderShortcodes` method

{{< new-in "0.117.0" >}} This renders all the shortcodes in the content, preserving the surrounding markup (e.g. Markdown) as is.

The common use case this is to composing a page from multiple content files while preserving a global context for table of contents and foot notes.

This method is most often used in shortcode templates. A simple example of shortcode template including content from another page would look like:

{{ $p := site.GetPage (.Get 0) }}
{{ $p.RenderShortcodes }}

In the above it's important to understand and the difference between the two delimiters used when including a shortcode:

{{</* myshortcode */>}} tells Hugo that the rendered shortcode does not need further processing (e.g. it's HTML).
{{%/* myshortcode */%}} tells Hugo that the rendered shortcode needs further processing (e.g. it's Markdown).

The latter is what you want to use for the include shortcode outlined above:

## Mypage
{{%/* include "mypage" */%}}

Also see Use Shortcodes.

Page-level params

Any other value defined in the front matter in a content file, including taxonomies, will be made available as part of the .Params variable.

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example categories: [one] tags: [two,three,four] {{< /code-toggle >}}

With the above front matter, the tags and categories taxonomies are accessible via the following:

.Params.tags
.Params.categories

The .Params variable is particularly useful for the introduction of user-defined front matter fields in content files. For example, a Hugo website on book reviews could have the following front matter:

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example affiliatelink: "http://www.my-book-link.here" recommendedby: "My Mother" {{< /code-toggle >}}

These fields would then be accessible to via .Params.affiliatelink and .Params.recommendedby.

<h3><a href="{{ .Params.affiliatelink }}">Buy this book</a></h3>
<p>It was recommended by {{ .Params.recommendedby }}.</p>

This template would render as follows:

<h3><a href="http://www.my-book-link.here">Buy this book</a></h3>
<p>It was recommended by my Mother.</p>

{{% note %}} See Archetypes for consistency of Params across pieces of content. {{% /note %}}

The `.Param` method

In Hugo, you can declare parameters in individual pages and globally for your entire website. A common use case is to have a general value for the site parameter and a more specific value for some of the pages (i.e., a header image):

{{ $.Param "header_image" }}

The .Param method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your site configuration).

Access nested fields in front matter

When front matter contains nested fields like the following:

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example author: given_name: John family_name: Feminella display_name: John Feminella {{< /code-toggle >}}

.Param can access these fields by concatenating the field names together with a dot:

{{ $.Param "author.display_name" }}

14 KiB Raw Blame History