markdown-it-admon

Plugin for creating admonitions for markdown-it markdown parser.

With this plugin you can create admonitions like:

!!! warning
    *here be dragons*

Markdown syntax follows python-markdown.

rST suggests the following "types": attention, caution, danger, error, hint, important, note, tip, and warning; however, you’re free to use whatever you want.

A styles file does support the following admonition types: Credits go to vscode-markdown-extended.

'note',
'summary', 'abstract', 'tldr',
'info', 'todo',
'tip', 'hint',
'success', 'check', 'done',
'question', 'help', 'faq',
'warning', 'attention', 'caution',
'failure', 'fail', 'missing',
'danger', 'error', 'bug',
'example', 'snippet',
'quote', 'cite'

Installation

node.js:

$ npm install markdown-it-admon --save

API

const md = require('markdown-it')()
             .use(require('markdown-it-admon') [, options]);

Params:

• name - container name (mandatory)
• options?:
  • render - optional, renderer function for opening/closing tokens.

License

MIT

References

• python-markdown
• rST
• vscode-markdown-extended