mirror of
https://github.com/gohugoio/hugo.git
synced 2025-04-28 14:40:43 +03:00
Merge commit 'b9bd35d72e
' as 'docs'
This commit is contained in:
commit
27aef3f1fb
735 changed files with 38220 additions and 0 deletions
41
docs/content/en/functions/safeHTML.md
Normal file
41
docs/content/en/functions/safeHTML.md
Normal file
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
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"
|
||||
keywords: [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:
|
||||
|
||||
```
|
||||
copyright = "© 2015 Jane Doe. <a href=\"https://creativecommons.org/licenses/by/4.0/\">Some rights reserved</a>."
|
||||
```
|
||||
|
||||
`{{ .Site.Copyright | safeHTML }}` in a template would then output:
|
||||
|
||||
```
|
||||
© 2015 Jane Doe. <a href="https://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:
|
||||
|
||||
```
|
||||
<p>© 2015 Jane Doe. <a href="https://creativecommons.org/licenses by/4.0/">Some rights reserved</a>.</p>
|
||||
```
|
||||
|
||||
[config]: /getting-started/configuration/
|
Loading…
Add table
Add a link
Reference in a new issue