HUGO
Menu
GitHub 87548 stars Mastodon

safe.HTML

Declares the given string as a safeHTML string.

Syntax

safe.HTML INPUT

Returns

template.HTML

Alias

safeHTML

Introduction

Hugo 使用 Go 的 text/templatehtml/template 包。

text/template 包实现数据驱动的模板以生成文本输出,而 html/template 包实现数据驱动的模板以生成可防止代码注入的安全 HTML 输出。

默认情况下,Hugo 在渲染 HTML 文件时使用 html/template 包。

为了生成可防止代码注入的安全 HTML 输出,html/template 包在某些上下文中转义字符串。

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>

Last updated: January 1, 0001
Improve this page