hugo/docs/content/en/functions/truncate.md
2023-05-22 16:47:07 +02:00

868 B

title description categories menu keywords signature relatedfuncs
truncate Truncates a text to a max length without cutting words or leaving unclosed HTML tags.
functions
docs
parent
functions
strings
truncate SIZE [ELLIPSIS] INPUT
strings.Truncate SIZE [ELLIPSIS] INPUT

Since Go templates are HTML-aware, truncate will intelligently handle normal strings vs HTML strings:

{{ "<em>Keep my HTML</em>" | safeHTML | truncate 10 }}` → <em>Keep my …</em>`

{{% note %}} If you have a raw string that contains HTML tags you want to remain treated as HTML, you will need to convert the string to HTML using the safeHTML template function before sending the value to truncate. Otherwise, the HTML tags will be escaped when passed through the truncate function. {{% /note %}}