hugo/docs/content/templates/variables.md

aliases	lastmod	date	linktitle	menu	next	prev	title	weight	toc
/doc/variables/ /layout/variables/	2016-08-22	2013-07-01	Variables	main parent layout	/templates/content	/templates/functions	Template Variables	20	true

Hugo makes a set of values available to the templates. Go templates are context based. The following are available in the context for the templates.

Page Variables

The following is a list of most of the accessible variables which can be defined for a piece of content. Many of these will be defined in the front matter, content or derived from file location.

See also: Scratch for page-scoped writable variables.

.Title The title for the content.
.Content The content itself, defined below the front matter.
.Summary A generated summary of the content for easily showing a snippet in a summary view. Note that the breakpoint can be set manually by inserting <!--more--> at the appropriate place in the content page. See Summaries for more details.
.Truncated A boolean, true if the .Summary is truncated. Useful for showing a "Read more..." link only if necessary. See Summaries for more details.
.Description The description for the content.
.Keywords The meta keywords for this content.
.Date The date the content is associated with.
.Lastmod The date the content was last modified.
.PublishDate The date the content is published on.
.ExpiryDate The date where the content is scheduled to expire on.
.Type The content type (e.g. post).
.Section The section this content belongs to.
.Permalink The Permanent link for this page.
.RelPermalink The Relative permanent link for this page.
.LinkTitle Access when creating links to this content. Will use linktitle if set in front matter, else title.
.RSSLink Link to the taxonomies' RSS link.
.TableOfContents The rendered table of contents for this content.
.Prev Pointer to the previous content (based on pub date).
.Next Pointer to the following content (based on pub date).
.PrevInSection Pointer to the previous content within the same section (based on pub date). For example, {{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}.
.NextInSection Pointer to the following content within the same section (based on pub date)
.FuzzyWordCount The approximate number of words in the content.
.WordCount The number of words in the content.
.ReadingTime The estimated time it takes to read the content in minutes.
.Weight Assigned weight (in the front matter) to this content, used in sorting.
.RawContent Raw Markdown content without the metadata header. Useful with remarkjs.com
.UniqueID The MD5-checksum of the page's filename
.Draft A boolean, true if the content is marked as a draft in the front matter.
.IsNode Always false for pages.
.IsPage Always true for page.
.Site See [Site Variables]({{< relref "#site-variables" >}}) below.
.Hugo See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.
.Translations A list of translated versions of the current page. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info. Note that the Translation variable is also available on node, e.g. home page etc.
.IsTranslated Whether there are any translations to display.
.Lang Language taken from the language extension notation.
.Author Returns the first listed author for a page
.Authors (note the plural form) Returns all listed authors for a page in the order they are defined in the front matter.

Page Params

Any other value defined in the front matter, including taxonomies, will be made available under .Params. For example, the tags and categories taxonomies are accessed with:

• .Params.tags
• .Params.categories

All Params are only accessible using all lowercase characters.

This is particularly useful for the introduction of user defined fields in content files. For example, a Hugo website on book reviews could have in the front matter of /content/review/book01.md

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

Which would then be accessible to a template at /themes/yourtheme/layouts/review/single.html through .Params.affiliatelink and .Params.recommendedby, respectively. Two common situations where these could be introduced are as a value of a certain attribute (like href="" below) or by itself to be displayed. Sample syntaxes include:

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

which would render

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

See also: [Archetypes]({{% ref "content/archetypes.md" %}}) for consistency of Params across pieces of content.

Param method

In Hugo you can declare params both for the site and the individual page. A common use case is to have a general value for the site and a more specific value for some of the pages (i.e. an image).

With the Param method the most specific value will be selected for you, and it is safe to use it in any template (it's defined on both Page and Node):

$.Param "image"

Node Variables

In Hugo, a node is any page not rendered directly by a content file. This includes taxonomies, lists and the homepage.

See also: Scratch for global node variables.

.Title The title for the content.
.Date The date the content is published on.
.Lastmod The date the content was last modified.
.Permalink The Permanent link for this node
.URL The relative URL for this node.
.Ref(ref) Returns the permalink for ref. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.
.RelRef(ref) Returns the relative permalink for ref. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.
.RSSLink Link to the taxonomies' RSS link.
.Data The data specific to this type of node.
.IsHome True if the node is the site home page.
.IsNode Always true for nodes.
.IsPage Always false for nodes.
.Site See [Site Variables]({{< relref "#site-variables" >}}) below.
.Hugo See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.
.Translations A list of translated versions of the current node. All nodes (except the pager nodes) can have translated counter parts. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info.
.IsTranslated Whether there are any translations to display.
.Lang The language code of this node.
.Author Returns the first defined author, sorted by their weight attribute.
.Authors (note the plural form) Returns all defined authors, sorted by their weight attribute.

Taxonomy Terms Node Variables

Taxonomy Terms pages are of the type "node" and have the following additional variables. These are available in layouts/_defaults/terms.html for example.

.Data.Singular The singular name of the taxonomy
.Data.Plural The plural name of the taxonomy
.Data.Pages the list of pages in this taxonomy
.Data.Terms The taxonomy itself
.Data.Terms.Alphabetical The Terms alphabetized
.Data.Terms.ByCount The Terms ordered by popularity

The last two can also be reversed: .Data.Terms.Alphabetical.Reverse, .Data.Terms.ByCount.Reverse.

Taxonomies elsewhere

The .Site.Taxonomies variable holds all taxonomies defines site-wide. It is a map of the taxonomy name to a list of its values. For example: "tags" -> ["tag1", "tag2", "tag3"]. Each value, though, is not a string but rather a Taxonomy variable.

The Taxonomy variable

The Taxonomy variable, available as .Site.Taxonomies.tags for example, contains the list of tags (values) and, for each of those, their corresponding content pages.

Site Variables

Also available is .Site which has the following:

.Site.BaseURL The base URL for the site as defined in the site configuration file.
.Site.RSSLink The URL for the site RSS.
.Site.Taxonomies The taxonomies for the entire site. Replaces the now-obsolete .Site.Indexes since v0.11. Also see section Taxonomies elsewhere.
.Site.Pages Array of all content ordered by Date, newest first. Replaces the now-deprecated .Site.Recent starting v0.13. This array contains only the pages in the current language.
.Site.AllPages Array of all pages regardless of their translation.
.Site.Params A container holding the values from the params section of your site configuration file. For example, a TOML config file might look like this:

baseurl = "http://yoursite.example.com/"

[params]
  description = "Tesla's Awesome Hugo Site"
  author = "Nikola Tesla"

.Site.Sections Top level directories of the site.
.Site.Files All of the source files of the site.
.Site.Menus All of the menus in the site.
.Site.Title A string representing the title of the site.
.Site.Authors An ordered list (ordered by defined weight) of the authors as defined in the site configuration. Have a look at acessible attributes.
.Site.LanguageCode A string representing the language as defined in the site configuration. This is mostly used to populate the RSS feeds with the right language code.
.Site.DisqusShortname A string representing the shortname of the Disqus shortcode as defined in the site configuration.
.Site.GoogleAnalytics A string representing your tracking code for Google Analytics as defined in the site configuration.
.Site.Copyright A string representing the copyright of your web site as defined in the site configuration.
.Site.LastChange A string representing the date/time of the most recent change to your site, based on the [date variable]({{< ref "content/front-matter.md#required-variables" >}}) in the front matter of your content pages.
.Site.Permalinks A string to override the default permalink format. Defined in the site configuration.
.Site.BuildDrafts A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.
.Site.Data Custom data, see Data Files.
.Site.IsMultiLingual Whether there are more than one language in this site.
See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info.
.Site.Language This indicates which language you are currently rendering the website for. This is an object with the attributes set in your language definition in your site config.
.Site.Language.Lang The language code of the current locale, e.g. en.
.Site.Language.Weight The weight that defines the order in the .Site.Languages list.
.Site.Language.LanguageName The full language name, e.g. English.
.Site.LanguagePrefix This can be used to prefix theURLs with whats needed to point to the correct language. It will even work when only one language defined. See also the functions [absLangURL and relLangURL]({{< relref "templates/functions.md#abslangurl-rellangurl" >}}).
.Site.Languages An ordered list (ordered by defined weight) of languages.

File Variables

The .File variable gives you additional information of a page.

Note: .File is only accessible on Pages but not on Nodes (like the homepage and list pages).

Available are the following attributes:

.File.Path The original relative path of the page, e.g. content/posts/foo.md
.File.LogicalName The name of the content file that represents a page, e.g. foo.md
.File.BaseFileName The filename without extension, e.g. foo
.File.Ext or .File.Extension The file extension of the content file, e.g. md
.File.Dir Given the path content/posts/dir1/dir2/, the relative directory path of the content file will be returned, e.g. posts/dir1/dir2/

Author variables

This variables are used for the author profiles feature. You can find a more in-depth explaination with examples [here]({{< relref "extras/authors.md" >}}).

The authors frontmatter variable represents a list of author identifiers. Those identifiers are used to match their corresponding profiles. .Author contains the profile associated with the first identifiers in the list.

.Author.ID The identifier of an author (a.k.a. the filename of his/her profile)
.Author.GivenName or .Author.FirstName The author's first name, e.g. Charles
.Author.FamilyName or .Author.LastName The author's last name, e.g. Dickens
.Author.DisplayName The author's full name, e.g. Charles Dickens
.Author.Thumbnail A link to a thumbnail of the author. Maybe the relative path to an image in the static folder
.Author.Image A larger image of the author. Can be stored in the static folder as well.
.Author.Bio A biography with background information about the author
.Author.ShortBio A summarized version of the biography
.Author.Email The email of the author
.Author.Weight The associated weight of an author. Defines the order of authors in the .Authors list (except on pages due to the frontmatter)
.Author.Social A container holding the values from the social section of the author's profile. For example, a TOML profile (excerpt) might look like this:

[social]
    facebook = "charles.dickens"
    twitter  = "charlesdickens"

.Author.Params A container holding the values from the params section of the author's file. The values can be arbitrary and depend on the profile. For example, a TOML profile (excerpt) might look like this:

[params]
    random = "whatever you want"

.Author.Social.URL Takes a social network as argument (as string) and generates the link the account automatically. A list of supported social networks and a template can be found [here]({{< relref "extras/authors.md#linking-social-network-accounts-automatically" >}}).

---

.Authors (note the plural form) is a list of all author profiles that are mentioned in the authors frontmatter variable.

.Authors.Get Takes the identifier of an author as argument (as string) and returns an .Author object.

Hugo Variables

Also available is .Hugo which has the following:

.Hugo.Generator Meta tag for the version of Hugo that generated the site. Highly recommended to be included by default in all theme headers so we can start to track the usage and popularity of Hugo. Unlike other variables it outputs a complete HTML tag, e.g. <meta name="generator" content="Hugo 0.15" />
.Hugo.Version The current version of the Hugo binary you are using e.g. 0.13-DEV
.Hugo.CommitHash The git commit hash of the current Hugo binary e.g. 0e8bed9ccffba0df554728b46c5bbf6d78ae5247
.Hugo.BuildDate The compile date of the current Hugo binary formatted with RFC 3339 e.g. 2002-10-02T10:00:00-05:00