summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/site/Params.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/site/Params.md')
-rw-r--r--docs/content/en/methods/site/Params.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/content/en/methods/site/Params.md b/docs/content/en/methods/site/Params.md
new file mode 100644
index 000000000..518d93bf3
--- /dev/null
+++ b/docs/content/en/methods/site/Params.md
@@ -0,0 +1,47 @@
+---
+title: Params
+description: Returns a map of custom parameters as defined in the site configuration.
+categories: []
+keywords: []
+action:
+ related:
+ - functions/collections/indexFunction
+ - methods/page/Params
+ - methods/page/Param
+ 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] the [identifiers]:
+
+```go-html-template
+{{ .Site.Params.subtitle }} → The Best Widgets on Earth
+{{ .Site.Params.author.name }} → John Smith
+
+{{ $layout := .Site.Params.layouts.rfc_1123 }}
+{{ .Site.LastChange.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
+[chaining]: /getting-started/glossary/#chain
+[identifiers]: /getting-started/glossary/#identifier