safe.URL

Introduction

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

text/template 包實現數據驅動的模板以生成文本輸出，而 html/template 包實現數據驅動的模板以生成可防止代碼注入的安全 HTML 輸出。

默認情況下，Hugo 在渲染 HTML 文件時使用 html/template 包。

為了生成可防止代碼注入的安全 HTML 輸出，html/template 包在某些上下文中轉義字符串。

Usage

Use the safe.URL function to encapsulate a known safe URL or URL substring. Schemes other than the following are considered unsafe:

• http:
• https:
• mailto:

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:

{{ $href := "irc://irc.freenode.net/#golang" }}
<a href="{{ $href }}">IRC</a>

Hugo renders the above to:

<a href="#ZgotmplZ">IRC</a>

To declare the string as safe:

{{ $href := "irc://irc.freenode.net/#golang" }}
<a href="{{ $href | safeURL }}">IRC</a>

Hugo renders the above to:

<a href="irc://irc.freenode.net/#golang">IRC</a>