This plugin adds admonition tag capability as in markdownIt plugin Admonition plug-in.
This plugin adds admonition blocks, using "!!!" as fences. See the following example.
!!! note This is the admonition title
This is the admonition body
!!!After the starting fence you should specify admonition type (changes color of rendered block) and optionally a title to be displayed. If title is not provided, admonition type name is used instead.
CSS used for rendering is taken from mkdocs-material, bar the icons, at the moment.
Block is rendered in a single DIV, as follows:
<div class="admonition note">
<p class="admonition-title">This is the admonition title</p>
<p>This is the admonition body</p>
</div>The following admonition types, supported by Docarys, are recognized by this plugin:
| Type |
|---|
| note |
| abstract |
| info |
| tip |
| success |
| question |
| warning |
| failure |
| danger |
| bug |
| example |
| quote |