diff options
Diffstat (limited to 'docs/content/en/functions/safe/CSS.md')
-rw-r--r-- | docs/content/en/functions/safe/CSS.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/content/en/functions/safe/CSS.md b/docs/content/en/functions/safe/CSS.md new file mode 100644 index 000000000..d5dcdfb66 --- /dev/null +++ b/docs/content/en/functions/safe/CSS.md @@ -0,0 +1,38 @@ +--- +title: safe.CSS +linkTitle: safeCSS +description: Declares the provided string as a known "safe" CSS string. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [safeCSS] + returnType: template.CSS + signatures: [safe.CSS INPUT] +relatedFunctions: + - safe.CSS + - safe.HTML + - safe.HTMLAttr + - safe.JS + - safe.JSStr + - safe.URL +aliases: [/functions/safecss] +--- + +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" is a special value that indicates that unsafe content reached a CSS or URL context. +{{% /note %}} |