Admonition Shortcode
This explains admonition shortcode implementation
234 Words … ⏲ Reading Time:1 Minute, 3 Seconds
2023-10-20 14:36 +0000
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
admonitionbanner, the default value isnote.title [optional] (second positional parameter)
Title of the
admonitionbanner, 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:
Summary
Summary is implemented in the admonition shortcode using type as summary.
{{< admonition type=summary title="This is a Summary headline" >}}
Details for the summary can be entered here
{{< /admonition >}}
Or
{{< admonition summary >}}
Details for the summary can be entered here (with no title)
{{< /admonition >}}
The rendered output looks like this:This is a Summary headline