An admonitions React component, ported from remarkable-admonitions. Perfect for Docusaurus v2 and other React-based doc generators.
NPM JavaScript Style Guide Build Status
Test the component out on Stackblitz, or view the demo
npm install --save react-admonitions
import React, { Component } from 'react' import Admonition from 'react-admonitions' class Example extends Component { render() { return ( <Admonition type="warning" title="Do not do this"> Admonition Content </Admonition> ) } }
| Name | Default | Description |
|---|---|---|
type |
none | What type of admonition you want to display. Valid options: "warning", "tip", "caution", "note", "important" |
iconType |
"svg" |
The type of admonition icon. Valid options: "svg", "emoji" |
title |
none | The, well, title of the admonition |
HTML, styles, and concept all come from the amazing Markdown plugin by @favoloso, remarkable-admonitions.
MIT © nebrelbug