hugo/docs/content/en/functions/delimit.md
2021-10-31 13:53:55 +01:00

1.8 KiB

title description date publishdate lastmod categories menu keywords toc signature workson hugoversion relatedfuncs deprecated draft aliases
delimit Loops through any array, slice, or map and returns a string of all the values separated by a delimiter. 2017-02-01 2017-02-01 2017-02-01
functions
docs
parent
functions
iteration
false
delimit COLLECTION DELIMIT LAST
lists
taxonomies
terms
false false

delimit called in your template takes the form of

{{ delimit array/slice/map delimiter optionallastdelimiter}}

delimit loops through any array, slice, or map and returns a string of all the values separated by a delimiter, the second argument in the function call. There is an optional third parameter that lets you choose a different delimiter to go between the last two values in the loop.

To maintain a consistent output order, maps will be sorted by keys and only a slice of the values will be returned.

The examples of delimit that follow all use the same front matter:

{{< code file="delimit-example-front-matter.toml" nocopy="true" >}} +++ title: I love Delimit tags: [ "tag1", "tag2", "tag3" ] +++ {{< /code >}}

{{< code file="delimit-page-tags-input.html" >}}

Tags: {{ delimit .Params.tags ", " }}

{{< /code >}}

{{< output file="delimit-page-tags-output.html" >}}

Tags: tag1, tag2, tag3

{{< /output >}}

Here is the same example but with the optional "last" delimiter:

{{< code file="delimit-page-tags-final-and-input.html" >}} Tags: {{ delimit .Params.tags ", " ", and " }} {{< /code >}}

{{< output file="delimit-page-tags-final-and-output.html" >}}

Tags: tag1, tag2, and tag3

{{< /output >}}