safe.HTML

Declares the given string as a safeHTML string.

Introduction #

Usage #

Use the safe.HTML function to encapsulate a known safe HTML document fragment. It should not be used for HTML from a third-party, or HTML with unclosed tags or comments.

Use of this type presents a security risk: the encapsulated content should come from a trusted source, as it will be included verbatim in the template output.

See the [Go documentation] for details.

Example #

Without a safe declaration:

{{ $html := "<em>emphasized</em>" }}
{{ $html }}

Hugo renders the above to:

&lt;em&gt;emphasized&lt;/em&gt;

To declare the string as safe:

{{ $html := "<em>emphasized</em>" }}
{{ $html | safeHTML }}

Hugo renders the above to:

<em>emphasized</em>