safe.JSStr

Introduction

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

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

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

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

Usage

Use the safe.JSStr function to encapsulate a sequence of characters meant to be embedded between quotes in a JavaScript expression.

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:

{{ $title := "Lilo & Stitch" }}
<script>
  const a = "Title: " + {{ $title }};
</script>

Hugo renders the above to:

<script>
  const a = "Title: " + "Lilo \u0026 Stitch";
</script>

To declare the string as safe:

{{ $title := "Lilo & Stitch" }}
<script>
  const a = "Title: " + {{ $title | safeJSStr }};
</script>

Hugo renders the above to:

<script>
  const a = "Title: " + "Lilo & Stitch";
</script>