mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-18 14:36:51 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
1.2 KiB
1.2 KiB
| title | description | categories | keywords | action | aliases | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| safe.HTML | Declares the given string as a safeHTML string. |
|
|
It should not be used for HTML from a third-party, or HTML with unclosed tags or comments.
Given a site-wide hugo.toml with the following copyright value:
{{< code-toggle file=hugo >}} copyright = "© 2015 Jane Doe. <a href="https://creativecommons.org/licenses/by/4.0/">Some rights reserved." {{< /code-toggle >}}
{{ .Site.Copyright | safeHTML }} in a template would then output:
© 2015 Jane Doe. <a href="https://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>.
However, without the safeHTML function, html/template assumes .Site.Copyright to be unsafe and therefore escapes all HTML tags and renders the whole string as plain text:
<p>© 2015 Jane Doe. <a href="https://creativecommons.org/licenses by/4.0/">Some rights reserved</a>.</p>