react-markdown-doc-loader
v3.0.6
Published
React backend for markdown-doc-loader
Downloads
65
Maintainers
Readme
react-markdown-doc-loader
A webpack loader to convert markdown-doc-loader
's output to React component.
markdown-doc-loader
converts a markdown file to a list of sections. There're three
types of section: markdown, style and demo.
Usage
Use as a webpack loader
{
module: {
rules: [
{
test: /\.md$/,
use: [
'babel-loader',
{
loader: require.resolve('react-markdown-doc-loader'),
options: {
jsTemplate: path.join(__dirname, './react-template.js'),
renderers: {
markdown: 'Markdown',
style: 'Style',
demo: 'Demo'
}
}
}
'markdown-doc-loader'
]
}
]
}
}
Options
jsTemplate
: path to js template file, usesbabel-template
.renderers
: a map of component names to different types of sections
Available properties in the template:
SECTIONS
: All sections in the file,style
,demo
andmarkdown
. Styles are compiled to css withprecss
demos are code fragments that return a React node markdowns are compiled to htmlIMPORTS
: All imports from demosDEMO_DECLARATIONS
: Declarations for demos
Take a look at sample/template.js
.