Params
Returns a map of custom parameters as defined in the front matter of the given page.
Syntax
PAGE.Params
Returns
maps.Params
By way of example, consider this front matter:
---
date: 2023-10-17T15:11:37-07:00
params:
author:
email: jsmith@example.org
name: John Smith
display_related: true
key-with-hyphens: must use index function
title: Annual conference
---+++
date = 2023-10-17T15:11:37-07:00
title = 'Annual conference'
[params]
display_related = true
key-with-hyphens = 'must use index function'
[params.author]
email = 'jsmith@example.org'
name = 'John Smith'
+++{
"date": "2023-10-17T15:11:37-07:00",
"params": {
"author": {
"email": "jsmith@example.org",
"name": "John Smith"
},
"display_related": true,
"key-with-hyphens": "must use index function"
},
"title": "Annual conference"
}
The title and date fields are standard front matter fields, while the other fields are user-defined.
Access the custom fields by chaining the identifiers when needed:
{{ .Params.display_related }} → true
{{ .Params.author.email }} → jsmith@example.org
{{ .Params.author.name }} → John SmithIn the template example above, each of the keys is a valid identifier. For example, none of the keys contains a hyphen. To access a key that is not a valid identifier, use the index function:
{{ index .Params "key-with-hyphens" }} → must use index function