Admonition Shortcode

The admonition shortcode supports 8 types of banners to help you put a notice on your page.

Markdown or HTML format in the content is supported.

The admonition shortcode has the following named parameters:

• type [optional] (first positional parameter)

  Type of the admonition banner, the default value is note.

• title [optional] (second positional parameter)

  Title of the admonition banner, the default value is the value of the type parameter.

Example admonition input:

{{< admonition type=tip title="This is a tip" >}}
A **tip** banner
{{< /admonition >}}
Or
{{< admonition tip "This is a tip" >}}
A **tip** banner
{{< /admonition >}}

The rendered output looks like this: