hugo-theme-relearn/exampleSite/content/shortcodes/notice.en.md

+++ description = "Disclaimers to help you structure your page" title = "Notice" +++

The notice shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.

{{% notice style="primary" title="There may be pirates" icon="skull-crossbones" %}} It is all about the boxes. {{% /notice %}}

Usage

While the examples are using named parameter you are free to use positional aswell.

{{< tabs >}} {{% tab name="named" %}}

{{%/* notice style="primary" title="There may be pirates" icon="skull-crossbones" */%}}
It is all about the boxes.
{{%/* /notice */%}}

{{% /tab %}} {{% tab name="positional" %}}

{{%/* notice primary "There may be pirates" "skull-crossbones" */%}}
It is all about the boxes.
{{%/* /notice */%}}

{{% /tab %}} {{< /tabs >}}

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]({{%relref "cont/icons#finding-an-icon" %}}) 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

{{% notice style="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) {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* notice style="info" */%}}
An **information** disclaimer

You can add standard markdown syntax:

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

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

> the possiblities are endless (almost - including other shortcodes may or may not work)
{{%/* /notice */%}}

{{% /expand %}}

Note

{{% notice style="note" %}} A notice disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

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

{{% /expand %}}

Tip

{{% notice style="tip" %}} A tip disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

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

{{% /expand %}}

Warning

{{% notice style="warning" %}} A warning disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

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

{{% /expand %}}

Warning with non-default title and icon

{{% notice style="warning" title="Here are dragons" icon="dragon" %}} A warning disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* notice style="warning" title="Here are dragons" icon="dragon" */%}}
A **warning** disclaimer
{{%/* /notice */%}}

{{% /expand %}}

Warning without a title and icon

{{% notice style="warning" title=" " icon=" " %}} A warning disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* notice style="warning" title=" " icon=" " */%}}
A **warning** disclaimer
{{%/* /notice */%}}

{{% /expand %}}

By Brand Colors

Primary with title only

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

{{% expand "Show markup" %}}

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

{{% /expand %}}

Secondary with icon only

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

{{% expand "Show markup" %}}

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

{{% /expand %}}

By Color

Blue without a title and icon

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

{{% expand "Show markup" %}}

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

{{% /expand %}}

Green with title only

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

{{% expand "Show markup" %}}

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

{{% /expand %}}

Grey with icon only

{{% notice style="grey" icon="bug" %}} A grey disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* notice style="grey" icon="bug" */%}}
A **grey** disclaimer
{{%/* /notice */%}}

{{% /expand %}}

Orange with title and icon

{{% notice style="orange" title="Orange" icon="bug" %}} A orange disclaimer {{% /notice %}}

{{% expand "Show markup" %}}

{{%/* notice style="orange" title="Orange" icon="bug" */%}}
A **orange** disclaimer
{{%/* /notice */%}}

{{% /expand %}}

Red

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

{{% expand "Show markup" %}}

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

{{% /expand %}}

By Special Color

Default with title and icon

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

{{% expand "Show markup" %}}

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

{{% /expand %}}

Transparent with title and icon

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

{{% expand "Show markup" %}}

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

{{% /expand %}}