zero-overhead markdown in your react components
add 'markdown-in-js/babel'
to the plugins
field of your babel config
import markdown from 'markdown-in-js'
// or
// var markdown = require('markdown-in-js')
// (You can use any identifier)
const App = () => markdown`
## This is some content.
You can write _markdown_ as you'd like.
${ <span> interpolate more <Content/> </span> }
you can <i>inline *html*</i> or even <OtherComponents/>, wow
<div style=${{ fontWeight: 'bold' }}
className=${'some more styles'}
class="pl-s1">${handler}>
interpolate attributes as expected
</div>
`
- gets compiled to react elements via a babel plugin
- preserves interpolations
- built with commonmark
- optionally add prismjs for syntax highlighting of code blocks
You can use custom components for markdown primitives like so -
import md from 'markdown-in-js'
import { MyHeading, MyLink } from './path/to/components'
const App = () => md({ h1: MyHeading, a: MyLink })`
# this will be a custom header
[custom link component](/url/to/link)
`
Before running the examples for the first time you'll need to npm run self-link
.
After that you can start webpack with npm start
.
- optionally no-wrap paragraphs
- optionally return array of elements
- instructions for in-editor syntax highlighting
- precompile code blocks
- commonmark options
- tests!