TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-18 13:35:03 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve explanation of safeHTMLAttr's function (#1503)

Browse Source 
Co-authored-by: Joe Mooring <joe.mooring@veriphor.com>
This commit is contained in:
Ayooluwa 2022-11-12 08:31:33 +01:00 committed by GitHub
parent b04a4b32e2
commit c27b545acb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
content/en/functions/safeHTMLAttr.md
View File

@ -26,5 +26,13 @@ Example: Given a site-wide `config.toml` that contains this menu entry:
url = "irc://irc.freenode.net/#golang"
{{< /code-toggle >}}
* <span class="bad">`<a href="{{ .URL }}">` &rarr; `<a href="#ZgotmplZ">`</span>
* <span class="good">`<a {{ printf "href=%q" .URL | safeHTMLAttr }}>` &rarr; `<a href="irc://irc.freenode.net/#golang">`</span>
Attempting to use the `url` value directly in an attribute like this:
- `<a href="{{ .URL }}"></a>` will produce the following: `<a href="#ZgotmplZ"></a>`.
The `ZgotmplZ` value indicates that you're trying to output content at a spot
where `template/html` deems to be unsafe. To correct the output, use the
`safeHTMLAttr` function like so:
- `<a {{ printf "href=%q" .URL | safeHTMLAttr }}></a>` which produces: `<a href="irc://irc.freenode.net/#golang"></a>`