mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
---
|
|||
title: safeHTML
|
|||
# linktitle:
|
|||
description: Declares a provided string as a "safe" HTML document to avoid escaping by Go templates.
|
|||
godocref: https://golang.org/src/html/template/content.go?s=1374:1385#L25
|
|||
date: 2017-02-01
|
|||
publishdate: 2017-02-01
|
|||
lastmod: 2017-02-01
|
|||
categories: [functions]
|
|||
menu:
|
|||
docs:
|
|||
parent: "functions"
|
|||
#tags: [strings]
|
|||
signature: ["safeHTML INPUT"]
|
|||
workson: []
|
|||
hugoversion:
|
|||
relatedfuncs: []
|
|||
deprecated: false
|
|||
---
|
|||
|
|||
It should not be used for HTML from a third-party, or HTML with unclosed tags or comments.
|
|||
|
|||
Given a site-wide [`config.toml`][config] with the following `copyright` value:
|
|||
|
|||
```toml
|
|||
copyright = "© 2015 Jane Doe. <a href=\"http://creativecommons.org/licenses/by/4.0/\">Some rights reserved</a>."
|
|||
```
|
|||
|
|||
`{{ .Site.Copyright | safeHTML }}` in a template would then output:
|
|||
|
|||
```html
|
|||
© 2015 Jane Doe. <a href="http://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>.
|
|||
```
|
|||
|
|||
However, without the `safeHTML` function, html/template assumes `.Site.Copyright` to be unsafe and therefore escapes all HTML tags and renders the whole string as plain text:
|
|||
|
|||
```html
|
|||
<p>© 2015 Jane Doe. <a href="http://creativecommons.org/licenses by/4.0/">Some rights reserved</a>.</p>
|
|||
```
|
|||
|
|||
[config]: /getting-started/configuration/
|
