Plugin icon

Admonition markdown extension

Description

Enables markdownIt admonition plugin, which enables formatting notes

Additional Information

Links:
Maintainers: maxnegro
Version:1.1.0
Minimum app version:1.8
Downloads: This version:5704
Last updated:2021-11-16T11:34:09Z

Joplin Admonition Markdown plugin

This plugin adds admonition tag capability as in markdownIt plugin Admonition plug-in.

Usage

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.

Appearance

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>

Admonition types

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