Notice

The notice shortcode shows various types of disclaimers with adjustable color, 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 shortcodes with named parameter you are free to use positional as well, use it as GitHub styled alerts or also call this shortcode from your own partials.

Note that if you want to use GitHub styled alerts Markdown, this is only available starting with Hugo 0.132.0. In this case no parameter from the below table are available.

> [!NOTE]
> It is all about the boxes.

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

{{ partial "shortcodes/notice.html" (dict
  "page"  .
  "style" "primary"
  "title" "There may be pirates"
  "icon" "skull-crossbones"
  "content" "It is all about the boxes."
)}}

Parameter

Name	Position	Default	Notes
style	1	`default`	The style scheme used for the box. - by severity: `caution`, `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	The CSS color value to be used. If not set, the chosen color depends on the style. Any given value will overwrite the default. - for severity styles: a nice matching color for the severity - for all other styles: the corresponding color
title	2	see notes	Arbitrary 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 styles: <empty> 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	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 styles: <empty> If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces)
expanded		<empty>	Whether to draw an expander and how the content is displayed. - <empty>: the content is shown but not collapsible - `true`: the expander is drawn and the content is initially shown - `false`: the expander is drawn and the content is initially hidden
<content>		<empty>	Arbitrary text to be displayed in box.

Configuration

If you are using GitHub styled alerts, by default the theme also accepts alert levels like info not known to GitHub’s implementation. If this interferes with your layout, you can turn this extension off by setting disableBlockquoteNoticeSupport=true in your hugo.toml.

Global Configuration File

This example reflects the default configuration also used if you don’t set anything explicitly.

hugo.

[params]
  disableBlockquoteNoticeSupport = false

params:
  disableBlockquoteNoticeSupport: false

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

Examples

By Severity Using Markdown Syntax

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!INFO]
> Information that users <ins>_might_</ins> find interesting.

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Important

Key information users need to know to achieve their goal.

Info

Information that users might find interesting.

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Warning

Urgent info that needs immediate user attention to avoid problems.

By Brand Colors with Title and Icon Variantion

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

{{% notice style="secondary" icon="stopwatch" %}}
A **secondary** disclaimer
{{% /notice %}}

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

Primary

A primary disclaimer

A secondary disclaimer

An accent disclaimer

By Color with Title and Icon Variantion

{{% 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" icon="bug" %}}
A **grey** disclaimer
{{% /notice %}}

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

{{% notice style="orange" title="Orange" icon="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 with Positional Parameter

{{% notice default "Pay Attention to this Note!" "skull-crossbones" %}}
Some serious information.
{{% /notice %}}

Pay Attention to this Note!

Some serious information.

Transparent with Title and Icon

{{% notice style="transparent" title="Pay Attention to this Note!" icon="skull-crossbones" %}}
Some serious information.
{{% /notice %}}

Pay Attention to this Note!

Some serious information.

Various Features

With User-Defined Color, Font Awesome Brand Icon and Markdown in Title and Content

You can add standard markdown syntax:

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

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

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

> the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)

Hugo is awesome

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 possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)

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

Expandable Content Area

{{% notice style="primary" title="Expand me..." expanded="true" %}}
No need to press you!
{{% /notice %}}

Expand me…

No need to press you!

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

Expand me…

Thank you!

No Content

Just a bar