mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-01 18:13:04 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
24 lines
906 B
Markdown
24 lines
906 B
Markdown
---
|
|
title: strings.Truncate
|
|
description: Returns the given string, truncating it to a maximum length without cutting words or leaving unclosed HTML tags.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
aliases: [truncate]
|
|
related: []
|
|
returnType: template.HTML
|
|
signatures: ['strings.Truncate SIZE [ELLIPSIS] INPUT']
|
|
aliases: [/functions/truncate]
|
|
---
|
|
|
|
Since Go templates are HTML-aware, `truncate` will intelligently handle normal strings vs HTML strings:
|
|
|
|
```go-html-template
|
|
{{ "<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`]function before sending the value to `truncate`. Otherwise, the HTML tags will be escaped when passed through the `truncate` function.
|
|
|
|
[`safeHTML`]: /functions/safe/html
|
|
{{% /note %}}
|