Front matter variables
Predefined
There are a few predefined variables that Hugo is aware of. See Page Variables for how to call many of these predefined variables in your templates.
aliases
An array of one or more aliases (e.g., old published paths of renamed content) that will be created in the output directory structure . See Aliases for details.
audio
An array of paths to audio files related to the page; used by the opengraph internal template to populate og:audio.
cascade
A map of front matter keys whose values are passed down to the page’s descendants unless overwritten by self or a closer ancestor’s cascade. See Front Matter Cascade for details.
date
The datetime assigned to this page. This is usually fetched from the date field in front matter, but this behavior is configurable.
description
The description for the content.
draft
If true, the content will not be rendered unless the --buildDrafts flag is passed to the hugo command.
expiryDate
The datetime at which the content should no longer be published by Hugo; expired content will not be rendered unless the --buildExpired flag is passed to the hugo command.
headless
If true, sets a leaf bundle to be headless.
images
An array of paths to images related to the page; used by internal templates such as _internal/twitter_cards.html.
isCJKLanguage
If true, Hugo will explicitly treat the content as a CJK language; both .Summary and .WordCount work properly in CJK languages.
keywords
The meta keywords for the content.
layout
The layout Hugo should select from the lookup order when rendering the content. If a type is not specified in the front matter, Hugo will look for the layout of the same name in the layout directory that corresponds with a content’s section. See Content Types.
lastmod
The datetime at which the content was last modified.
linkTitle
Used for creating links to content; if set, Hugo defaults to using the linkTitle before the title.
markup
experimental; specify "rst" for reStructuredText (requiresrst2html) or "md" (default) for Markdown.
outputs
Allows you to specify output formats specific to the content. See output formats.
publishDate
If in the future, content will not be rendered unless the --buildFuture flag is passed to hugo.
resources
Used for configuring page bundle resources. See Page Resources.
series
An array of series this page belongs to, as a subset of the series taxonomy; used by the opengraph internal template to populate og:see_also.
slug
Overrides the last segment of the URL path. Not applicable to section pages. See URL Management for details.
summary
Text used when providing a summary of the article in the .Summary page variable; details available in the content-summaries section.
title
The title for the content.
type
The type of the content; this value will be automatically derived from the directory (i.e., the section) if not specified in front matter.
url
Overrides the entire URL path. Applicable to regular pages and section pages. See URL Management for details.
videos
An array of paths to videos related to the page; used by the opengraph internal template to populate og:video.
weight
used for ordering your content in lists. Lower weight gets higher precedence. So content with lower weight will come first. If set, weights should be non-zero, as 0 is interpreted as an unset weight.
taxonomies
Field name of the plural form of the index. See tags and categories in the above front matter examples. Note that the plural form of user-defined taxonomies cannot be the same as any of the predefined front matter variables.