summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/page/Keywords.md
blob: 7c940984effad690f8a400bd0aa50dcb246ddd4c (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
43
44
45
46
---
title: Keywords
description: Returns a slice of keywords as defined in front matter.
categories: []
keywords: []
params:
  functions_and_methods:
    returnType: '[]string'
    signatures: [PAGE.Keywords]
---

By default, Hugo evaluates the keywords when creating collections of [related content].

[related content]: /content-management/related-content/

{{< code-toggle file=content/recipes/sushi.md fm=true >}}
title = 'How to make spicy tuna hand rolls'
keywords = ['tuna','sriracha','nori','rice']
{{< /code-toggle >}}

To list the keywords within a template:

```go-html-template
{{ range .Keywords }}
  {{ . }}
{{ end }}
```

Or use the [delimit] function:

```go-html-template
{{ delimit .Keywords ", " ", and " }} → tuna, sriracha, nori, and rice
```

[delimit]: /functions/collections/delimit/

Keywords are also a useful [taxonomy]:

{{< code-toggle file=hugo >}}
[taxonomies]
tag = 'tags'
keyword = 'keywords'
category = 'categories'
{{< /code-toggle >}}

[taxonomy]: /content-management/taxonomies/