hugo/docs/content/templates/variables.md

---
aliases:
- /doc/variables/
- /layout/variables/
date: 2013-07-01
linktitle: Variables
menu:
  main:
    parent: layout
next: /templates/content
prev: /templates/functions
title: Template Variables
weight: 20
---

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.

**.Title**  The title for the content.<br>
**.Content** The content itself, defined below the front matter.<br>
**.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 <code>&lt;!&#x2d;&#x2d;more&#x2d;&#x2d;&gt;</code> at the appropriate place in the content page.<br>
**.Description** The description for the content.<br>
**.Keywords** The meta keywords for this content.<br>
**.Date** The date the content is associated with.<br>
**.PublishDate** The date the content is published on.<br>
**.Type** The content [type](/content/types/) (e.g. post).<br>
**.Section** The [section](/content/sections/) this content belongs to.<br>
**.Permalink** The Permanent link for this page.<br>
**.RelPermalink** The Relative permanent link for this page.<br>
**.LinkTitle** Access when creating links to this content. Will use linktitle if set in front-matter, else title.<br>
**.Taxonomies** These will use the field name of the plural form of the index (see tags and categories above).<br>
**.RSSLink** Link to the indexes' rss link.<br>
**.TableOfContents** The rendered table of contents for this content.<br>
**.Prev** Pointer to the previous content (based on pub date).<br>
**.Next** Pointer to the following content (based on pub date).<br>
**.PrevInSection** Pointer to the previous content within the same section (based on pub date)<br>
**.NextInSection** Pointer to the following content within the same section (based on pub date)<br>
**.FuzzyWordCount** The approximate number of words in the content.<br>
**.WordCount** The number of words in the content.<br>
**.ReadingTime** The estimated time it takes to read the content in minutes.<br>
**.Weight** Assigned weight (in the front matter) to this content, used in sorting.<br>
**.IsNode** Always false for pages.<br>
**.IsPage** Always true for page.<br>
**.Site** See site variables below.<br>

## Page Params

Any other value defined in the front matter, including indexes will be made available under `.Params`.
Take for example I'm using tags and categories as my indexes. The following would be how I would access them:

**.Params.tags** <br>
**.Params.categories** <br>
<br>
**All Params are only accessible using all lowercase characters**<br>

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

**.Title**  The title for the content.<br>
**.Date** The date the content is published on.<br>
**.Permalink** The Permanent link for this node<br>
**.Url** The relative url for this node.<br>
**.Ref(ref)** Returns the permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
**.RelRef(ref)** Returns the relative permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
**.RSSLink** Link to the indexes' rss link <br>
**.Data** The data specific to this type of node.<br>
**.IsNode** Always true for nodes.<br>
**.IsPage** Always false for nodes.<br>
**.Site** See site variables below<br>

## 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.<br>
**.Site.Taxonomies** The indexes for the entire site.<br>
**.Site.LastChange** The date of the last change of the most recent content.<br>
**.Site.Recent** Array of all content ordered by Date, newest first.<br>
**.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.<br>
**.Site.Pages** All of the content pages of the site.<br>
**.Site.Files** All of the source files of the site.<br>
**.Site.Menus** All of the menus in the site.<br>
**.Site.Title** A string representing the title of the site.<br>
**.Site.Author** A map of the authors as defined in the site configuration.<br>
**.Site.LanguageCode** A string representing the language as defined in the site configuration.<br>
**.Site.DisqusShortname** A string representing the shortname of the Disqus shortcode as defined in the site configuration.<br>
**.Site.Copyright** A string representing the copyright of your web site as defined in the site configuration.<br>
**.Site.LastChange** A string representing the last time content has been updated.<br>
**.Site.Permalinks** A string to override the default permalink format. Defined in the site configuration.<br>
**.Site.BuildDrafts** A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.<br>
sanity: move from json to yaml 2013-07-06 23:36:30 +00:00			`---`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`aliases:`
			`- /doc/variables/`
			`- /layout/variables/`
			`date: 2013-07-01`
			`linktitle: Variables`
Implementing new menu system in the docs site 2014-04-23 07:00:11 +00:00			`menu:`
			`main:`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`parent: layout`
			`next: /templates/content`
			`prev: /templates/functions`
			`title: Template Variables`
			`weight: 20`
YAML support similar to jekyll (start and end with '---') 2013-07-08 21:57:01 +00:00			`---`
adding hugo 2013-07-04 15:32:55 +00:00
			`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.`

Complete overhaul of the docs 2013-08-17 12:34:25 +00:00			`## Page Variables`

Updating page variable documentation (for templates). 2014-01-22 01:05:26 +00:00			`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.`

Added .Content variable to docs 2013-08-08 23:13:03 +00:00			`.Title The title for the content.<br>`
Updating page variable documentation (for templates). 2014-01-22 01:05:26 +00:00			`.Content The content itself, defined below the front matter.<br>`
Docs: Quote <!--more--> in <code> instead of italicizing it Also replace "--" with "--" prevent "--" from being interpreted as en-dash. Note: A simple `<!--more-->` does not work. 2014-10-17 01:00:09 +00:00			`.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 <code><!--more--></code> at the appropriate place in the content page.<br>`
adding hugo 2013-07-04 15:32:55 +00:00			`.Description The description for the content.<br>`
			`.Keywords The meta keywords for this content.<br>`
Add future details to documentation 2014-05-29 05:00:06 +00:00			`.Date The date the content is associated with.<br>`
			`.PublishDate The date the content is published on.<br>`
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</…/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode. 2014-11-25 08:07:18 +00:00			`.Type The content [type](/content/types/) (e.g. post).<br>`
			`.Section The [section](/content/sections/) this content belongs to.<br>`
adding hugo 2013-07-04 15:32:55 +00:00			`.Permalink The Permanent link for this page.<br>`
Adding support for linkTitles 2013-10-25 22:37:53 +00:00			`.RelPermalink The Relative permanent link for this page.<br>`
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</…/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode. 2014-11-25 08:07:18 +00:00			`.LinkTitle Access when creating links to this content. Will use linktitle if set in front-matter, else title.<br>`
			`.Taxonomies These will use the field name of the plural form of the index (see tags and categories above).<br>`
			`.RSSLink Link to the indexes' rss link.<br>`
			`.TableOfContents The rendered table of contents for this content.<br>`
			`.Prev Pointer to the previous content (based on pub date).<br>`
			`.Next Pointer to the following content (based on pub date).<br>`
Add in-section Next/Prev content pointers Conflicts: docs/content/meta/release-notes.md docs/content/templates/variables.md 2014-04-18 07:23:13 +00:00			`.PrevInSection Pointer to the previous content within the same section (based on pub date)<br>`
			`.NextInSection Pointer to the following content within the same section (based on pub date)<br>`
Updating page variable documentation (for templates). 2014-01-22 01:05:26 +00:00			`.FuzzyWordCount The approximate number of words in the content.<br>`
			`.WordCount The number of words in the content.<br>`
			`.ReadingTime The estimated time it takes to read the content in minutes.<br>`
			`.Weight Assigned weight (in the front matter) to this content, used in sorting.<br>`
Adding IsNode & IsPage functions to Page & Node 2014-08-20 01:27:13 +00:00			`.IsNode Always false for pages.<br>`
			`.IsPage Always true for page.<br>`
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</…/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode. 2014-11-25 08:07:18 +00:00			`.Site See site variables below.<br>`
adding hugo 2013-07-04 15:32:55 +00:00
Updating page variable documentation (for templates). 2014-01-22 01:05:26 +00:00			`## Page Params`

			Any other value defined in the front matter, including indexes will be made available under `.Params`.
adding hugo 2013-07-04 15:32:55 +00:00			`Take for example I'm using tags and categories as my indexes. The following would be how I would access them:`

Updating page variable documentation (for templates). 2014-01-22 01:05:26 +00:00			`.Params.tags <br>`
			`.Params.categories <br>`
			`<br>`
			`All Params are only accessible using all lowercase characters<br>`
Complete overhaul of the docs 2013-08-17 12:34:25 +00:00
			`## Node Variables`
			`In Hugo a node is any page not rendered directly by a content file. This`
			`includes indexes, lists and the homepage.`

			`.Title The title for the content.<br>`
			`.Date The date the content is published on.<br>`
			`.Permalink The Permanent link for this node<br>`
			`.Url The relative url for this node.<br>`
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</…/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode. 2014-11-25 08:07:18 +00:00			.Ref(ref) Returns the permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
			.RelRef(ref) Returns the relative permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
Complete overhaul of the docs 2013-08-17 12:34:25 +00:00			`.RSSLink Link to the indexes' rss link <br>`
Updating page variable documentation (for templates). 2014-01-22 01:05:26 +00:00			`.Data The data specific to this type of node.<br>`
Adding IsNode & IsPage functions to Page & Node 2014-08-20 01:27:13 +00:00			`.IsNode Always true for nodes.<br>`
			`.IsPage Always false for nodes.<br>`
Complete overhaul of the docs 2013-08-17 12:34:25 +00:00			`.Site See site variables below<br>`

			`## Site Variables`
adding hugo 2013-07-04 15:32:55 +00:00
			Also available is `.Site` which has the following:

Fixed error in tutorial, added site variable docs While following the github pages tutorial I found some issues. These are the commands I ran that worked. Added site variables to the docs from the code. 2015-01-12 04:05:32 +00:00			`.Site.BaseUrl The base URL for the site as defined in the site configuration file.<br>`
More taxonomy examples in templates. 2014-08-30 03:41:53 +00:00			`.Site.Taxonomies The indexes for the entire site.<br>`
adding hugo 2013-07-04 15:32:55 +00:00			`.Site.LastChange The date of the last change of the most recent content.<br>`
Documentation updates, mostly for my bits * extras/permalinks.md added, weighted to third in the extras menu * examples added to layout/go-templates.md, using `.Site.Params` * mention `.Site.Params` in layout/variables.md * update meta/release-notes.md to mention `first` and the permalinks * update overview/configuration.md to use reserved-for-documentation domains and with another example, nudging towards permalinks and site parameters, with three different data-types shown for the latter Signed-off-by: Noah Campbell <noahcampbell@gmail.com> 2013-11-18 23:31:02 +00:00			`.Site.Recent Array of all content ordered by Date, newest first.<br>`
Add config file example to variables.md Add a config file example for setting .Site.Params to variables.md. This addresses my confusion in [issue #766](https://github.com/spf13/hugo/issues/766). 2015-01-05 10:49:10 +00:00			.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"`
Fixed error in tutorial, added site variable docs While following the github pages tutorial I found some issues. These are the commands I ran that worked. Added site variables to the docs from the code. 2015-01-12 04:05:32 +00:00			`.Site.Sections Top level directories of the site.<br>`
			`.Site.Pages All of the content pages of the site.<br>`
			`.Site.Files All of the source files of the site.<br>`
			`.Site.Menus All of the menus in the site.<br>`
			`.Site.Title A string representing the title of the site.<br>`
			`.Site.Author A map of the authors as defined in the site configuration.<br>`
			`.Site.LanguageCode A string representing the language as defined in the site configuration.<br>`
			`.Site.DisqusShortname A string representing the shortname of the Disqus shortcode as defined in the site configuration.<br>`
			`.Site.Copyright A string representing the copyright of your web site as defined in the site configuration.<br>`
			`.Site.LastChange A string representing the last time content has been updated.<br>`
			`.Site.Permalinks A string to override the default permalink format. Defined in the site configuration.<br>`
			`.Site.BuildDrafts A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.<br>`