diff options
Diffstat (limited to 'docs/content/en/functions/safeCSS.md')
-rw-r--r-- | docs/content/en/functions/safeCSS.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/content/en/functions/safeCSS.md b/docs/content/en/functions/safeCSS.md new file mode 100644 index 000000000..11c10923b --- /dev/null +++ b/docs/content/en/functions/safeCSS.md @@ -0,0 +1,36 @@ +--- +title: safeCSS +description: Declares the provided string as a known "safe" CSS string. +godocref: https://golang.org/src/html/template/content.go?s=919:929#L15 +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-26 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [style,css,strings] +signature: ["safeCSS INPUT"] +workson: [] +hugoversion: +relatedfuncs: [safeHTML,safeHTMLAttr,] +deprecated: false +aliases: [] +--- + +In this context, *safe* means CSS content that matches any of the following: + +1. The CSS3 stylesheet production, such as `p { color: purple }`. +2. The CSS3 rule production, such as `a[href=~"https:"].foo#bar`. +3. CSS3 declaration productions, such as `color: red; margin: 2px`. +4. The CSS3 value production, such as `rgba(0, 0, 255, 127)`. + +Example: Given `style = "color: red;"` defined in the front matter of your `.md` file: + +* <span class="good">`<p style="{{ .Params.style | safeCSS }}">…</p>` → `<p style="color: red;">…</p>`</span> +* <span class="bad">`<p style="{{ .Params.style }}">…</p>` → `<p style="ZgotmplZ">…</p>`</span> + +{{% note "ZgotmplZ" %}} +"ZgotmplZ" is a special value that indicates that unsafe content reached a CSS or URL context. +{{% /note %}} + |