Notice

Th' notice shortcode 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 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)
expanded		<empty>	Whether t' draw an expander an' how th' rrrambl'n be displayed. - <empty>: th' rrrambl'n be shown but not collaps'ble - `true`: th' expander be drawn an' th' rrrambl'n be initially shown - `false`: th' expander be drawn an' th' rrrambl'n be initially hidden
<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.

hugo.

[params]
  disableBlockquoteNoticeSupport = false

params:
  disableBlockquoteNoticeSupport: false

{
   "params": {
      "disableBlockquoteNoticeSupport": false
   }
}

Examples

By Severity Us'n Marrrkdown Rules

> [!CAUTION]
> Advises about risks or negative outcomes o' certain act'ns.

> [!IMPORTANT]
> Key informat'n users need t' know t' achieve their goal.

> [!INFO]
> Informat'n that users <ins>_might_</ins> find interest'n.

> [!NOTE]
> Useful informat'n that users should know, even when skimm'n rrrambl'n.

> [!TIP]
> Helpful advice fer do'n th'ns better or more easily.

> [!WARNING]
> Urgent info that needs immediate user attent'n t' avoid problems.

Caut'n

Advises about risks or negative outcomes o' certain act'ns.

Important

Key informat'n users need t' know t' achieve their goal.

Ahoi

Informat'n that users might find interest'n.

Avast

Useful informat'n that users should know, even when skimm'n rrrambl'n.

Smarrrt Arrrse

Helpful advice fer do'n th'ns better or more easily.

Arrr

Urgent info that needs immediate user attent'n t' avoid problems.

By Brand Colors wit' Title an' Ay'con Variant'n

{{% notice style="primary" title="Primary" %}}
A **primary** disclaimer
{{% /notice %}}

{{% notice style="secondary" ay'con="stopwatch" %}}
A **secondary** disclaimer
{{% /notice %}}

{{% notice style="accent" %}}
An **accent** disclaimer
{{% /notice %}}

Primary

A primary disclaimer

A secondary disclaimer

An accent disclaimer

By Color wit' Title an' Ay'con Variant'n

{{% notice style="blue" %}}
A **blue** disclaimer
{{% /notice %}}

{{% notice style="cyan" title="Cyan" %}}
A **cyan** disclaimer
{{% /notice %}}

{{% notice style="green" title="Green" %}}
A **green** disclaimer
{{% /notice %}}

{{% notice style="grey" ay'con="bug" %}}
A **grey** disclaimer
{{% /notice %}}

{{% notice style="magenta" title="Magenta" %}}
A **magenta** disclaimer
{{% /notice %}}

{{% notice style="orange" title="Orange" ay'con="bug" %}}
A **orange** disclaimer
{{% /notice %}}

{{% notice style="red" %}}
A **red** disclaimer
{{% /notice %}}

A blue disclaimer

Cyan

A cyan disclaimer

Green

A green disclaimer

A grey disclaimer

Magenta

A magenta disclaimer

Orange

A orange disclaimer

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 %}}

Pay Attent'n t' this Avast!

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 %}}

Pay Attent'n t' this Avast!

Some serious informat'n.

Various Features

Wit' User-Defined Color, Font Awesome Brand Ay'con an' Marrrkdown 'n Title an' Rrrambl'n

Ye can add standard markdown rules:

- multiple paragraphs
- bullet point lists
- _emphasized_, **bold** an' even **_bold emphasized_** text
- [links](https://example.com)
- etc.[^etc]

[^etc]: Et Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean "and other similar things", or "and so forth"

```plaintext
...and even source code
```

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

Cap'n Hugo be awesome

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' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)

Et Cetera (English: /ɛtˈsɛtərə/), abbreviated t' etc., etc, et cet., be a Latin expression that be used 'n English t' mean “and other similar things”, or “and so forth” ↩︎

Expand'ble Rrrambl'n Area

{{% notice style="primary" title="Expand me..." expanded="true" %}}
No need t' press ye!
{{% /notice %}}

Expand me…

No need t' press ye!

{{% notice style="primary" title="Expand me..." expanded="false" %}}
Thank ye!
{{% /notice %}}

Expand me…

Thank ye!

No Rrrambl'n

Just a bar