diff options
Diffstat (limited to 'docs/content/en/functions/strings/Truncate.md')
| -rw-r--r-- | docs/content/en/functions/strings/Truncate.md | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/docs/content/en/functions/strings/Truncate.md b/docs/content/en/functions/strings/Truncate.md index 0bd78d840..17ae0afc6 100644 --- a/docs/content/en/functions/strings/Truncate.md +++ b/docs/content/en/functions/strings/Truncate.md @@ -1,17 +1,13 @@ --- title: strings.Truncate -linkTitle: truncate -description: Truncates a text to a max length without cutting words or leaving unclosed HTML tags. -categories: [functions] +description: Returns the given string, truncating it to a maximum length without cutting words or leaving unclosed HTML tags. +categories: [] keywords: [] -menu: - docs: - parent: functions -function: +action: aliases: [truncate] + related: [] returnType: template.HTML signatures: ['strings.Truncate SIZE [ELLIPSIS] INPUT'] -relatedFunctions: [] aliases: [/functions/truncate] --- @@ -22,5 +18,7 @@ Since Go templates are HTML-aware, `truncate` will intelligently handle normal s ``` {{% 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](/functions/safe/html) before sending the value to truncate. Otherwise, the HTML tags will be escaped when passed through the `truncate` function. +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 %}} |