ContextQMD
Back to Hugo

safe.HTML

docs/content/en/functions/safe/HTML.md

0.161.1890 B
Original Source

Introduction

{{% include "/_common/functions/go-html-template-package.md" %}}

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:

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

Hugo renders the above to:

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

To declare the string as safe:

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

Hugo renders the above to:

html
<em>emphasized</em>