Extended Shortcode - Admonition

The admonition shortcode allows you to add various types of callouts to your content.

Parameters

The admonition shortcode has the following named parameters, and the positional parameters ordered from top to bottom:

Basic Usage

Example admonition input:

1
2
3
4
5
6
7

{{< admonition type=quote title="[FixIt](https://github.com/hugo-fixit/FixIt)" open=true >}}
A **clean**, **elegant** but **advanced** blog theme for [Hugo](https://gohugo.io/).
{{< /admonition >}}
Or
{{< admonition quote "[FixIt](https://github.com/hugo-fixit/FixIt)" true >}}
A **clean**, **elegant** but **advanced** blog theme for [Hugo](https://gohugo.io/).
{{< /admonition >}}

The rendered output looks like this:

Supported types

The admonition shortcode supports 13 types of banners, Unless you Customize admonitions, any unsupported type defaults to the note type. The type identifier is case-insensitive.

The complete examples are as follows:

{{< admonition >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition abstract >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition info >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition todo >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition tip >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition success >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition question >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition warning >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition failure >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition danger >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition bug >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition example >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}

{{< admonition quote >}}
The quick brown fox jumps over the lazy dog.
{{< /admonition >}}