Skip to content

An admonition plugin for markdown-it powered by docarys.io

License

Notifications You must be signed in to change notification settings

docarys/markdown-it-admonition

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Travis npm

Admonition plug-in

A simple admonition plugin for markdown-it

Usage

To use this plugin, simply:

npm install markdown-it-admonition --save
    var markdown = require("markdown-it")({html: true})        
        .use(require("markdown-it-admonition"));
!!! 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.

About

An admonition plugin for markdown-it powered by docarys.io

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published