Page-level variables are defined in a content file’s front matter, derived from the content’s file location, or extracted from the content body itself.
The following is a list of page-level variables. Many of these will be defined in the front matter, derived from file location, or extracted from the content itself.
See
.Scratch
for page-scoped, writable variables.A simple, in-browser, markdown-driven slideshow tool. Βελτιώστε τις δεξιότητες παρουσίασης του PowerPoint με αυτά τα πρότυπα και τα εργαλεία του PowerPoint. Με το σωστό μίγμα, μπορείτε να κάνετε τις παρουσιάσεις σας πιο δημιουργικές και διασκεδαστικές. This document will introduce participants to the basics of R Markdown. After an introduction to concepts related to reproducible programming and research, demonstrations of standard markdown, as. Reactjs next.js remarkjs react-markdown. Improve this question. Follow asked Apr 4 at 12:03. Damunga damunga. 75 2 2 silver badges 8 8 bronze badges.
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 thedate
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 theexpirydate
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
issection
.- .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
, ortaxonomyTerm
. Note that there are alsoRSS
,sitemap
,robotsTXT
, and404
kinds, but these are only available during the rendering of each of these respective page’s kind and therefore not available in any of thePages
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 thelastmod
field in a content’s front matter.
- If
lastmod
is not set, and.GitInfo
feature is disabled, the front matterdate
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 beforetitle
. - .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 returnsnil
. - .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 returnsnil
. - .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
withinthe 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 returnsnil
. - .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 returnsnil
. - .PublishDate
- the date on which the content was or will be published;
.Publishdate
pulls from thepublishdate
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 <!--more--> 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.
- .CurrentSection
- The page’s current section. The value can be the page itself if it is a section or the homepage.
- .FirstSection
- The page’s first section below root, e.g.
/docs
,/blog
etc. - .InSection $anotherPage
- Whether the given page is in the current section.
- .IsAncestor $anotherPage
- Whether the current page is an ancestor of the given page.
- .IsDescendant $anotherPage
- Whether the current page is a descendant of the given page.
- .Parent
- A section’s parent section or a page’s section.
- .Section
- The section this content belongs to. Note: For nested sections, this is the first path element in the directory, for example,
/blog/funny/mypost/ => blog
. - .Sections
- The sections below this content.
The .Pages
Variable
.Pages
is an alias to .Data.Pages
. It is conventional to use thealiased form .Pages
..Pages
compared to .Site.Pages
- A regular page is a “post” page or a “content” page.
- A leaf bundle is a regular page.
- A list page can list regular pages and other list pages. Someexamples are: homepage, section pages, taxonomy term (
/tags/
) andtaxonomy (/tags/foo/
) pages.- A branch bundle is a list page.
.Site.Pages
- Collection of all pages of the site: regular pages,sections, taxonomies, etc. – Superset of everything!
.Site.RegularPages
- Collection of only regular pages.
The above
.Site. .
page collections can be accessed from any scope inthe templates.Below variables return a collection of pages only from the scope ofthe current list page:
.Pages
- Collection of regular pages and only first-levelsection pages under the current list page.
.RegularPages
- Collection of only regular pages under thecurrent list page. This excludes regular pages in nested sections/list pages (those are subdirectories with an
_index.md
file. .RegularPagesRecursive
- Collection of allregular pages under a list page. This includes regular pages in nested sections/list pages.
This feature was added in Hugo version 0.68.0
- Note
- From the scope of regular pages,
.Pages
and.RegularPages
return an empty slice.
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.With the above front matter, the
tags
and categories
taxonomies are accessible via the following:.Params.tags
.Params.categories
Page-level
.Params
are only accessible in lowercase.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
: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.This template would render as follows, assuming you’ve set
uglyURLs
to false
in your site config
:See Archetypes for consistency of
Params
across pieces of content.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): Mike pompeo family history.
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:
.Param
can access these fields by concatenating the field names together with a dot:If your front matter contains a top-level key that is ambiguous with a nested key, as in the following case:
![Remarkjs Remarkjs](/uploads/1/1/8/5/118537875/164398680.png)
The top-level key will be preferred. Therefore, the following method, when applied to the previous example, will print
vanilla
and not chocolate
:See Also
Page-level variables are defined in a content file’s front matter, derived from the content’s file location, or extracted from the content body itself.
The following is a list of page-level variables. Many of these will be defined in the front matter, derived from file location, or extracted from the content itself.
See
.Scratch
for page-scoped, writable variables.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 thedate
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 theexpirydate
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
issection
.- .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
, ortaxonomyTerm
. Note that there are alsoRSS
,sitemap
,robotsTXT
, and404
kinds, but these are only available during the rendering of each of these respective page’s kind and therefore not available in any of thePages
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 thelastmod
field in a content’s front matter.
- If
lastmod
is not set, and.GitInfo
feature is disabled, the front matterdate
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 beforetitle
. - .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 returnsnil
. - .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 returnsnil
. - .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
withinthe 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 returnsnil
. - .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 returnsnil
. - .PublishDate
- the date on which the content was or will be published;
.Publishdate
pulls from thepublishdate
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 <!--more--> 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.
- .CurrentSection
- The page’s current section. The value can be the page itself if it is a section or the homepage.
- .FirstSection
- The page’s first section below root, e.g.
/docs
,/blog
etc. - .InSection $anotherPage
- Whether the given page is in the current section.
- .IsAncestor $anotherPage
- Whether the current page is an ancestor of the given page.
- .IsDescendant $anotherPage
- Whether the current page is a descendant of the given page.
- .Parent
- A section’s parent section or a page’s section.
- .Section
- The section this content belongs to. Note: For nested sections, this is the first path element in the directory, for example,
/blog/funny/mypost/ => blog
. - .Sections
- The sections below this content.
The .Pages
Variable
.Pages
is an alias to .Data.Pages
. It is conventional to use thealiased form .Pages
..Pages
compared to .Site.Pages
Remarkjs Examples
- A regular page is a “post” page or a “content” page.
- A leaf bundle is a regular page.
- A list page can list regular pages and other list pages. Someexamples are: homepage, section pages, taxonomy term (
/tags/
) andtaxonomy (/tags/foo/
) pages.- A branch bundle is a list page.
.Site.Pages
- Collection of all pages of the site: regular pages,sections, taxonomies, etc. – Superset of everything!
.Site.RegularPages
- Collection of only regular pages.
The above
.Site. .
page collections can be accessed from any scope inthe templates.Below variables return a collection of pages only from the scope ofthe current list page:
.Pages
- Collection of regular pages and only first-levelsection pages under the current list page.
.RegularPages
- Collection of only regular pages under thecurrent list page. This excludes regular pages in nested sections/list pages (those are subdirectories with an
_index.md
file. .RegularPagesRecursive
- Collection of allregular pages under a list page. This includes regular pages in nested sections/list pages.
This feature was added in Hugo version 0.68.0
- Note
- From the scope of regular pages,
.Pages
and.RegularPages
return an empty slice.
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.With the above front matter, the
tags
and categories
taxonomies are accessible via the following:.Params.tags
.Params.categories
Page-level
.Params
are only accessible in lowercase.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
:These fields would then be accessible to the
/themes/yourtheme/layouts/review/single.html
template through .Params.affiliatelink
and .Params.recommendedby
, respectively. See all results for this question.Remarkjs Markdown
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.This template would render as follows, assuming you’ve set
uglyURLs
to false
in your site config
:See Archetypes for consistency of
Params
across pieces of content.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):
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:
.Param
can access these fields by concatenating the field names together with a dot:If your front matter contains a top-level key that is ambiguous with a nested key, as in the following case:
The top-level key will be preferred. Therefore, the following method, when applied to the previous example, will print
vanilla
and not chocolate
:Imagine dragons guitar pro. Get the best Imagine Guitar Pro tab by John Lennon @ 911Tabs.Com - tabs search engine. Last updated on. Guitar Pro for Imagine by John Lennon. Find the best version for your choice. Chords and tablature aggregator - Tabstabs.com. Imagine Guitar Pro (ver. 7) Filesize: 14 Kb. Instruments: bass, percussion, vocal, keyboard #1, keyboard #2, other. Tuning: Contributor: sfraLoll. To download 'Imagine' Guitar Pro tab. You must have Guitar Pro software installed on your computer in order. Imagine by Lennon, John. On this page you will find the Guitar Pro tab for the song Imagine by Lennon, John, which has been downloaded 18,643 times. Please note that you need to have the Guitar Pro software before you can start using these. The tablature provided is our visitor's interpretation of this song but remain a property of their respective authors, artists and labels.