1.0.4 • Published 7 years ago
markdown-it-admonition v1.0.4
Admonition plug-in
A simple admonition plugin for markdown-it
Usage
To use this plugin, simply:
npm install markdown-it-adminition --save var markdown = require("markdown-it")({html: true})
.use(require("markdown-it-adminition"));!!! note This is the admonition title
This is the admonition body
!!!This will output the following HTML
<div class="admonition note">
<p class="admonition-title">This is the admonition title</p>
<p>This is the admonition body</p>
</div>The following adminition types, supported by Docarys, are recognized by this plugin:
| Type |
|---|
| note |
| abstract |
| info |
| tip |
| success |
| question |
| warning |
| failure |
| danger |
| bug |
| example |
| quote" |
You can customize the types you want to use by passing it as opts.
if no title is specified, admonition type will be used as default title.