@raid/markdown-kit v0.18.2

react-markdown-kit

Uses @raid/basic-kit components to render markdown

Getting Started

Install with yarn or npm

yarn add @raid/markdown-kit

npm i -S @raid/markdown-kit

The markdown component converts markdown into DOM via React components which tie in with the @raid/basic-kit components.

import { Markdown } from '@raid/markdown-kit'
import { md } from './content.md'

render(
  <Markdown>{md}</Markdown,
  document.body
)

The elements property can be used to specify which components to use for which bits of Markdown. It uses markdown-to-jsx under the hood so mdx is also supported.

Contributing

Pull requests are always welcome, the project uses the standard code style. Please run npm test to ensure all tests are passing and add tests for any new features or updates.

For bugs and feature requests, please create an issue.

See the root readme for more information about how the repository is structured.

License

MIT