Notice

Arrr! ☠ Pirrrates ☠

Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.

Th' notice shorrrtcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.

There may be pirates

It be all about th' boxes.

Usage

While th' examples be us'n named parameter ye be free t' use positional aswell.

{{% notice style="primary" title="There may be pirates" ay'con="skull-crossbones" %}}
It be all about th' boxes.
{{% /notice %}}
{{% notice primary "There may be pirates" "skull-crossbones" %}}
It be all about th' boxes.
{{% /notice %}}

Parameter

Name Posit'n Optional Default Notes
style 1 yes default Th' color scheme used t' highlight th' box rrrambl'n.

- 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 fer th' box title. Depend'n on th' style there may be a default title. Any given value will overwrite th' default.

- fer severity styles: th' match'n title fer th' severity
- fer all other colors: <empty>

If ye want no title fer a severity style, ye have t' set this parameter t' " " (a non empty str'n filled wit' spaces)
ay'con 3 yes see notes Font Awesome ay'con name set t' th' left o' th' title. Depend'n on th' style there may be a default ay'con. Any given value will overwrite th' default.

- fer severity styles: a nice match'n ay'con fer th' severity
- fer all other colors: <empty>

If ye want no ay'con fer a severity style, ye have t' set this parameter t' " " (a non empty str'n filled wit' spaces)

Examples

By Severity

Ahoi wit' marrrkup

Ahoi

An informat'n disclaimer

Ye can add standard markdown rules:

  • multiple paragraphs
  • bullet point lists
  • emphasized, bold an' even bold emphasized text
  • links
  • etc.
...and even source code

th' possiblities be endless (almost - includ'n other shorrrtcodes may or may not work)

Show marrrkup

Avast

Avast

A notice disclaimer

Show marrrkup

Smarrrt Arrrse

Smarrrt Arrrse

A tip disclaimer

Show marrrkup

Arrr

Arrr

A warning disclaimer

Show marrrkup

Arrr wit' non-default title an' ay'con

Here be dragons

A warning disclaimer

Show marrrkup

Arrr without a title an' ay'con

A warning disclaimer

Show marrrkup

By Brand Colors

Primary wit' title only

Primary

A primary disclaimer

Show marrrkup

Secondary wit' ay'con only

A secondary disclaimer

Show marrrkup

By Color

Blue without a title an' ay'con

A blue disclaimer

Show marrrkup

Green wit' title only

Green

A green disclaimer

Show marrrkup

Grey wit' ay'con only

A grey disclaimer

Show marrrkup

Orange wit' title an' ay'con

Orange

A orange disclaimer

Show marrrkup

Red

A red disclaimer

Show marrrkup

By Special Color

Default wit' title an' ay'con

Pay Attent'n t' this Avast!

Some serious informat'n.

Show marrrkup

Transparent wit' title an' ay'con

Pay Attent'n t' this Avast!

Some serious informat'n.

Show marrrkup