hugo/content/en/variables/page.md at bd77f6e1c99e04a476f0b1bb4e44569134e02399

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

Bjørn Erik Pedersen 32ba623541 Squashed 'docs/' changes from bcc4f9324..4c81c6c2a

4c81c6c2a live reload: add section about `--navigateToChanged`
271014257 Update netify hugo version to 0.83.1
14199cff1 Add pull_request event
0c33b05de Hosting on GitHub: Little wording fixes and update Ubuntu runner in example workflow to 20.04 (#1457)
e47b6c33a Hugo Modules plural typo (#1266)
0f2bbacdd Add node_modules to .gitignore
1d645d79f Overhaul scratch.md (#1451)
572766889 Add link to golang regex syntax, change modified date
21b0c7459 Add info about contentType config
de7d96fa2 Document Go template's multiline support
0c8f2dcb1 Avoid scratch usage
696fa92e1 Rename scratch var
44193f267 Update usage instructions
4230f8fa5 Rename and refactor shortcode
e9953751e Strip leading whitespaces
d61a58010 Add `insertpages` shortcode
04d30677d Mention WebP under 'Target Format' (#1431)
946784508 Update lookup-order.md (#1443)
a7b587988 Update index.md
27907f7ea netlify: Hugo 0.83.1
044d37e57 Merge branch 'tempv0.83.1'
b81aedb03 Fix page `.Kind`
fcf7775ad releaser: Add release notes to /docs for release of 0.83.1
9b39c77c8 fix typo in 0.83 release notes
1c38993ce Update index.md
45b8aefa6 Update index.md
43902dfaa Update index.md
3d959c7ae Merge branch 'tempv0.83.0'
6c22dc327 Fix URL
497ea3224 Use Hugo version badge shortcode
a182d10dd releaser: Add release notes to /docs for release of 0.83.0
287fd9ac0 docs: Fix shortcode
e789c879a docs: Regenerate docs helper
1666c7f31 docs: Regenerate CLI docs
117de1d12 Merge commit 'c239c643fee10bfa217cb108755b798f8f5f3b10'
a6bf3f7d9 docs: Regen docs helper

git-subtree-dir: docs
git-subtree-split: 4c81c6c2ace6c23d0d5d24ee37e6a2f30acba01e

2021-06-08 18:46:58 +02:00

12 KiB

Raw Blame History

title

linktitle

description

date

publishdate

lastmod

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
.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; .Date pulls from the date field in a content's front matter. See also .ExpiryDate, .PublishDate, and .Lastmod.
.Description: the description for the page.
.Dir: the path of the folder containing this content file. The path is relative to the content folder.
.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; .ExpiryDate pulls from the expirydate field in a content's front matter. See also .PublishDate, .Date, and .Lastmod.
.File: filesystem-related data for this content file. See also File Variables.
.FuzzyWordCount: the approximate number of words in the content.
.Hugo: see Hugo Variables.
.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 config. .Language.Lang gives you the language code.
.Lastmod: the date the content was last modified. .Lastmod pulls from the lastmod field in a content's front matter.

If lastmod is not set, and .GitInfo feature is disabled, the front matter date field will be used.
If lastmod is not set, and .GitInfo feature is enabled, .GitInfo.AuthorDate will be used instead.

See also .ExpiryDate, .Date, .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.)
.Pages: a collection of associated pages. This value will be nil within the context of regular content pages. See .Pages.
.Permalink: the Permanent link for this page; see Permalinks
.Plain: the Page content stripped of HTML tags and presented as a string.
.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; .Publishdate pulls from the publishdate field in a content's front matter. See also .ExpiryDate, .Date, and .Lastmod.
.RSSLink (deprecated): link to the page's RSS feed. This is deprecated. You should instead do something like this: {{ with .OutputFormats.Get "RSS" }}{{ .RelPermalink }}{{ end }}.
.RawContent: raw markdown content without the front matter. Useful with remarkjs.com
.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).
.UniqueID (deprecated): the MD5-checksum of the content file's path. This variable is deprecated and will be removed, use .File.UniqueID instead.
.Weight: assigned weight (in the front matter) to this content, used in sorting.
.WordCount: the number of words in the content.

Section Variables and Methods

Also see Sections.

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

The `.Pages` Variable

.Pages is an alias to .Data.Pages. It is conventional to use the aliased form .Pages.

`.Pages` compared to `.Site.Pages`

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.

---
title: My First Post
date: 2017-02-20T15:26:23-06:00
categories: [one]
tags: [two,three,four]

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

.Params.tags
.Params.categories

{{% note "Casing of Params" %}} Page-level .Params are only accessible in lowercase. {{% /note %}}

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 in /content/review/book01.md:

---
...
affiliatelink: "http://www.my-book-link.here"
recommendedby: "My Mother"
...
---

These fields would then be accessible to the /themes/yourtheme/layouts/review/single.html template through .Params.affiliatelink and .Params.recommendedby, respectively.

Two common situations where this type of front matter field could be introduced is as a value of a certain attribute like href="" or by itself to be displayed as text to the website's visitors.

Buy this book

It was recommended by {{ .Params.recommendedby }}.

This template would render as follows, assuming you've set uglyURLs to false in your site config:

Buy this book

It was recommended by my Mother.

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

The `.Param` Method

In Hugo, you can declare params in individual pages and globally for your entire website. A common use case is to have a general value for the site param 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 config).

Access Nested Fields in Front Matter

When front matter contains nested fields like the following:

---
author:
  given_name: John
  family_name: Feminella
  display_name: John Feminella
---

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

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

If your front matter contains a top-level key that is ambiguous with a nested key, as in the following case:

---
favorites.flavor: vanilla
favorites:
  flavor: chocolate
---

The top-level key will be preferred. Therefore, the following method, when applied to the previous example, will print vanilla and not chocolate:

{{ $.Param "favorites.flavor" }}
=> vanilla

12 KiB Raw Blame History

Page Variables

Section Variables and Methods

The .Pages Variable

.Pages compared to .Site.Pages

Page-level Params

Buy this book

Buy this book

The .Param Method

Access Nested Fields in Front Matter

12 KiB

Raw Blame History

The `.Pages` Variable

`.Pages` compared to `.Site.Pages`

The `.Param` Method