mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-25 22:00:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

tpl: Add truncate template function

Browse Source 
This commit adds a truncate template function for safely truncating text without
breaking words. The truncate function is HTML aware, so if the input text is a
template.HTML it will be truncated without leaving broken or unclosed HTML tags.

    {{ "this is a very long text" | truncate 10 " ..." }}
    {{ "With [Markdown](/markdown) inside." | markdownify | truncate 10 }}
This commit is contained in:
Mathias Biilmann
2017-01-06 01:42:32 -08:00
committed by Bjørn Erik Pedersen
parent 9c19ef0f87
commit 2989c38245
5 changed files with 253 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/content/templates/functions.md
View File

@@ -662,6 +662,16 @@ e.g.
* `{{slicestr "BatMan" 3}}` → "Man"
* `{{slicestr "BatMan" 0 3}}` → "Bat"
### truncate
Truncate a text to a max length without cutting words or leaving unclosed HTML tags. Since Go templates are HTML-aware, truncate will handle normal strings vs HTML strings intelligently. It's important to note that if you have a raw string that contains HTML tags that you want 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 by truncate.
e.g.
* `{{ "this is a text" | truncate 10 " ..." }}` → `this is a ...`
* `{{ "<em>Keep my HTML</em>" | safeHTML | truncate 10 }}` → `<em>Keep my …</em>`
* `{{ "With [Markdown](#markdown) inside." | markdownify | truncate 10 }}` → `With <a href='#markdown'>Markdown …</a>`
### split
Split a string into substrings separated by a delimiter.