Notice
Th' notice shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.
It be all about th' boxes.
Usage
While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well, use it as GitHub styled alerts or also call this shortcode from yer own partials.
Avast that if ye want t' use GitHub styled alerts Marrrkdown, this be only avail'ble start'n wit' Cap'n Hugo 0.132.0. In this case no parameter from th' below t'ble be avail'ble.
> [!NOTE]
> It be all about th' boxes.{{% 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 %}}{{ partial "shortcodes/notice.html" (dict
"page" .
"style" "primary"
"title" "There may be pirates"
"icon" "skull-crossbones"
"content" "It be all about th' boxes."
)}}Parameter
| Name | Posit'n | Default | Notes |
|---|---|---|---|
| style | 1 | default |
Th' style scheme used fer th' box. - by severity: caut'n, important, info, note, tip, warning- by brand color: primary, secondary, accent- by color: blue, cyan, green, grey, magenta, orange, red- by special color: default, transparent, code |
| color | see notes | Th' CSS color value t' be used. If not set, th' chosen color depends on th' style. Any given value will overwrite th' default. - fer severity styles: a nice match'n color fer th' severity - fer all other styles: th' correspond'n color |
|
| title | 2 | see notes | Arbitrary 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 styles: <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 | 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 styles: <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) |
| <content> | <empty> | Arbitrary text t' be displayed 'n box. |
Configurat'n
If ye be us'n GitHub styled alerts, by default th' theme also accepts alert levels like info not known t' GitHub’s implementat'n. If this interferes wit' yer layout, ye can turn this extension off by sett'n disableBlockquoteNoticeSupport=true 'n yer hugo.toml.
Global Configurat'n File
This example reflects th' default configurat'n also used if ye don’t set anyth'n explicitly.
[params]
disableBlockquoteNoticeSupport = falseparams:
disableBlockquoteNoticeSupport: false{
"params": {
"disableBlockquoteNoticeSupport": false
}
}Examples
By Severity
Caut'n wit' marrrkup
{{% notice style="caution" %}}
An **caut'n** disclaimer
Ye can add standard markdown rules:
- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** an' even ***bold emphasized*** text
- [links](https://example.com)
- etc.
```plaintext
...and even source code
```
> th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)
{{% /notice %}}An caut'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 codeth' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)
Important
{{% notice style="important" %}}
A **important** disclaimer
{{% /notice %}}A important disclaimer
Ahoi
{{% notice style="info" %}}
A **informat'n** disclaimer
{{% /notice %}}A informat'n disclaimer
Avast
{{% notice style="note" %}}
A **notice** disclaimer
{{% /notice %}}A notice disclaimer
Smarrrt Arrrse
{{% notice style="tip" %}}
A **tip** disclaimer
{{% /notice %}}A tip disclaimer
Arrr
{{% notice style="warning" %}}
A **warning** disclaimer
{{% /notice %}}A warning disclaimer
Arrr wit' Non-Default Title an' Ay'con
{{% notice style="warning" title="Here be dragons" ay'con="dragon" %}}
A **warning** disclaimer
{{% /notice %}}A warning disclaimer
Arrr without a Title an' Ay'con
{{% notice style="warning" title=" " ay'con=" " %}}
A **warning** disclaimer
{{% /notice %}}A warning disclaimer
By Brand Colors
Primary wit' Title only
{{% notice style="primary" title="Primary" %}}
A **primary** disclaimer
{{% /notice %}}A primary disclaimer
Secondary wit' Ay'con only
{{% notice style="secondary" ay'con="stopwatch" %}}
A **secondary** disclaimer
{{% /notice %}}A secondary disclaimer
Accent
{{% notice style="accent" %}}
An **accent** disclaimer
{{% /notice %}}An accent disclaimer
By Color
Blue without a Title an' Ay'con
{{% notice style="blue" %}}
A **blue** disclaimer
{{% /notice %}}A blue disclaimer
Green wit' Title only
{{% notice style="green" title="Green" %}}
A **green** disclaimer
{{% /notice %}}A green disclaimer
Grey wit' Ay'con only
{{% notice style="grey" ay'con="bug" %}}
A **grey** disclaimer
{{% /notice %}}A grey disclaimer
Orange wit' Title an' Ay'con
{{% notice style="orange" title="Orange" ay'con="bug" %}}
A **orange** disclaimer
{{% /notice %}}A orange disclaimer
Red without a Title an' Ay'con
{{% notice style="red" %}}
A **red** disclaimer
{{% /notice %}}A red disclaimer
By Special Color
Default wit' Positional Parameter
{{% notice default "Pay Attent'n t' this Avast!" "skull-crossbones" %}}
Some serious informat'n.
{{% /notice %}}Some serious informat'n.
Transparent wit' Title an' Ay'con
{{% notice style="transparent" title="Pay Attent'n t' this Avast!" ay'con="skull-crossbones" %}}
Some serious informat'n.
{{% /notice %}}Some serious informat'n.
Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown Title
{{% notice color="fuchsia" title="**Hugo**" ay'con="fa-fw fab fa-hackerrank" %}}
Victor? Be it ye?
{{% /notice %}}Victor? Be it ye?