mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
46 lines
992 B
Markdown
46 lines
992 B
Markdown
---
|
|
title: Keywords
|
|
description: Returns a slice of keywords as defined in front matter.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
related: []
|
|
returnType: '[]string'
|
|
signatures: [PAGE.Keywords]
|
|
---
|
|
|
|
By default, Hugo evaluates the keywords when creating collections of [related content].
|
|
|
|
[related content]: /content-management/related
|
|
|
|
{{< 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
|