diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-10-21 10:21:37 +0200 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-10-21 10:21:51 +0200 |
| commit | 39121de4d991bdcf5f202da4d8d81a8ac6c149fc (patch) | |
| tree | 97e0b638fea1d898de9e297732d1044b49bfba8e /docs/content/en/functions/safeHTML.md | |
| parent | 180195aa342777fece1b29a08ec89456d7996c61 (diff) | |
docs: Replace /docs
Diffstat (limited to 'docs/content/en/functions/safeHTML.md')
| -rw-r--r-- | docs/content/en/functions/safeHTML.md | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/docs/content/en/functions/safeHTML.md b/docs/content/en/functions/safeHTML.md deleted file mode 100644 index 5a59fc2cb..000000000 --- a/docs/content/en/functions/safeHTML.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -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=\"http://creativecommons.org/licenses/by/4.0/\">Some rights reserved</a>." -``` - -`{{ .Site.Copyright | safeHTML }}` in a template would then output: - -``` -© 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: - -``` -<p>© 2015 Jane Doe. <a href="http://creativecommons.org/licenses by/4.0/">Some rights reserved</a>.</p> -``` - -[config]: /getting-started/configuration/ |