Notice
The notice shortcode shows various types of disclaimers with adjustable title and icon to help you structure your page.
There may be pirates
It is all about the boxes.
Usage
While the examples are using named parameter you are free to use positional aswell.
{{% notice style="primary" title="There may be pirates" icon="skull-crossbones" %}}
It is all about the boxes.
{{% /notice %}}
{{% notice primary "There may be pirates" "skull-crossbones" %}}
It is all about the boxes.
{{% /notice %}}
Parameter
| Name | Position | Optional | Default | Notes |
|---|---|---|---|---|
| style | 1 | yes | default |
The color scheme used to highlight the box content. - by severity: info, note, tip, warning- by brand color: primary, secondary- by color: blue, green, grey, orange, red- by special color: default, transparent |
| title | 2 | yes | see notes | Arbitray text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default. - for severity styles: the matching title for the severity - for all other colors: no title If you want no title for a severity style, you have to set this parameter to " " (a non empty string filled with spaces) |
| icon | 3 | yes | see notes | Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default. - for severity styles: a nice matching icon for the severity - for all other colors: no icon If you want no icon for a severity style, you have to set this parameter to " " (a non empty string filled with spaces) |
Examples
By Severity
Info with markup
Info
An information disclaimer
You can add standard markdown syntax:
- multiple paragraphs
- bullet point lists
- emphasized, bold and even bold emphasized text
- links
- etc.
...and even source code
the possiblities are endless (almost - including other shortcodes may or may not work)
Note
Note
A notice disclaimer
Tip
Tip
A tip disclaimer
Warning
Warning
A warning disclaimer
Warning with non-default title and icon
Here are dragons
A warning disclaimer
Warning without a title and icon
A warning disclaimer
By Brand Colors
Primary with title only
Primary
A primary disclaimer
Secondary with icon only
A secondary disclaimer
By Color
Blue without a title and icon
A blue disclaimer
Green with title only
Green
A green disclaimer
Grey with icon only
A grey disclaimer
Orange with title and icon
Orange
A orange disclaimer
Red
A red disclaimer
By Special Color
Default with title and icon
Pay Attention to this Note!
Some serious information.
Transparent with title and icon
Pay Attention to this Note!
Some serious information.