remarkable-admonitions


Adds admonitions parsing support to Remarkable. (There's also a React component)

Installation

With npm:

``sh
npm install --save remarkable-admonitions
`

or with Yarn:

`sh
yarn add remarkable-admonitions
`

Usage

`js
import Remarkable from 'remarkable';
const md = new Remarkable();

import admonitions from 'remarkable-admonitions';
md.use(admonitions());

md.render(
:::caution
Beware Ogre
:::
);
/* ->


Supported admonition types are: caution, note, important, tip,
warning.

By default block title is the admonition type. You can provide a custom title
after the opening tag:

`md
:::note This is my custom title
A note.
:::
`

$3

If you are using Docusaurus, you can load the plugin
in siteConfig.js:

`js
const siteConfig = {
// ...
markdownPlugins: [
// Highlight admonitions.
require('remarkable-admonitions')({ icon: 'svg-inline' })
]
};
`

There is a style developed to match its visual appearence (the same you can see
in the preview image up here). Due to Docusaurus CSS loading system, you need to download the css from
docusaurus-admonitions.css and place it
into your custom/ folder.

Options

You may configure this plugin with the following options:

| Option | Default | Description |
| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| icon | emoji | Allows to use a different method to render admonition icons. By default it uses emoji (unicode Emojis). Choose svg-inline` to use Octicons. |