blob: 8467be41dea3b9a32a06c8b66d12580956cd839b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
---
title: Params
description: Returns a map of custom parameters as defined in the site configuration.
categories: []
keywords: []
params:
functions_and_methods:
returnType: maps.Params
signatures: [SITE.Params]
---
With this site configuration:
{{< code-toggle file=hugo >}}
[params]
subtitle = 'The Best Widgets on Earth'
copyright-year = '2023'
[params.author]
email = 'jsmith@example.org'
name = 'John Smith'
[params.layouts]
rfc_1123 = 'Mon, 02 Jan 2006 15:04:05 MST'
rfc_3339 = '2006-01-02T15:04:05-07:00'
{{< /code-toggle >}}
Access the custom parameters by [chaining](g) the [identifiers](g):
```go-html-template
{{ .Site.Params.subtitle }} → The Best Widgets on Earth
{{ .Site.Params.author.name }} → John Smith
{{ $layout := .Site.Params.layouts.rfc_1123 }}
{{ .Site.Lastmod.Format $layout }} → Tue, 17 Oct 2023 13:21:02 PDT
```
In 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:
```go-html-template
{{ index .Site.Params "copyright-year" }} → 2023
```
[`index`]: /functions/collections/indexfunction/
|
