safe.HTML

简介

Hugo 使用 Go 的 text/template 与 html/template 包。

text/template 包实现数据驱动的模板，用于生成文本输出；html/template 包实现数据驱动的模板，用于生成可抵御代码注入的 HTML 输出。

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

为了生成可抵御代码注入的 HTML 输出，html/template 包会在特定上下文中对字符串进行转义。

用法

使用 safe.HTML 函数封装已知安全的 HTML 文档片段。不要用它处理来自第三方的 HTML，也不要处理带有未闭合标签或注释的 HTML。

使用该类型会带来安全风险：封装的内容应当来自可信来源，因为它会被原样写入模板输出。

详情请参见 Go 文档。

示例

未做安全声明时：

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

Hugo 将上述代码渲染为：

<em>emphasized</em>

要把该字符串声明为安全：

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

Hugo 将上述代码渲染为：

<em>emphasized</em>