<span style="color: #883DAA;font-family: "Helvetica Neue", sans;">react-down ⚛ ⬇
Transform Markdown to React elements.
Introduction
react-down is a simple library and React component to transform Markdown formatted text into native React elements. react-down uses markdown-it to parse Markdown and directly translate it into a structure of React elements.
Usage
react-down can be used as a function that returns a React element or as a React component:
const src = `# Hello, Markdown!This is an *example*.` const main = document // Using the React component:ReactDOM // Using the transform function:ReactDOM
See the example for more details.
Plugins
A plugin is a function that returns a React element. The function is called for each HTML element in the source Markdown and it receives the following arguments:
type: string
- HTML tag name (e.g. h1, p, etc.)props: Object
- existing properties (e.g.key
)children: ?Array<Object>
- existing React child elementstoken: Object
- Original markdown-it token
{ if type === 'h1' return React } const main = document // Using the React component:ReactDOM // Using the transform function:const myTransform = transformReactDOM