markdown-it-react-component

markdown-it-react-component

Plugin to support react component for markdown-it markdown parser

With this plugin you can support react component like:

``` rc
function Hello(props){
    return (
        <div>
            Hello:
            <p style={{color:'red'}}>{props.text}</p>
        </div>
    )
}
return (
    <div>
        <Hello text="World"/>
    </div>
);

## Installation

Only browser:

```bash
$ npm install markdown-it-react-component --save

API

import MarkdownIt from "markdown-it";
import { SupportReactComponent } from "markdown-it-react-component";

const md = new MarkdownIt().use(md => SupportReactComponent(md,[, options]))

Params

• options:
  • sandbox - optional,sandbox to provide plugin,such as React Component.
  • babelOptions - optional,Babel Options,defalut:

  {
    presets: ['stage-3', 'react', 'es2015'],
    plugins: ['filterXSS']
  }
  

  • babelInit - optional,Babel initialization callback.
  • enableSSR - optional,Whether to enable SSR rendering.defalut:true
  • allowErrorLog - optional,Whether log the info of render react code error.defalut:false

Example

run npm run storybook

Test

run npm run test

License

MIT