A Webpack loader for converting Markdown files to React components

Downloads in past


5151.2.04 years ago5 years agoMinified + gzip package size for markdown-to-react-loader in KB



NpmVersion NpmDownloads Build Status

A Webpack loader for converting Markdown files to React components (JSX).
Currently supports imports, syntax highlighting, and extra data.
This loader was built for the purpose of documenting React Components, but can be used for other static documents you want to convert to HTML.

It turns this:

# Hello, World

Its great to be here!

Into this:

import React, { Fragment } from 'react';
const Markdown = () => (
    <h1>Hello, World</h1>
    <p>Its great to be here!</p>
export default Markdown;

Note: Requires React 16.2+
yarn add --dev markdown-to-react-loader
npm install --save-dev markdown-to-react-loader
Because it outputs ES6 and JSX its recommended to use in conjunction with the babel-loader to compile for your targetted environment.
yarn add --dev babel-loader @babel/preset-env @babel/preset-react
npm install --save-dev babel-loader @babel/preset-env @babel/preset-react

Update your Webpack config:
  test: /\.md$/,
  exclude: /node_modules/,
  use: [
    	loader: 'babel-loader',
      options: {
          presets: ['@babel/env', '@babel/react']

Then you can use the loader like:

# Hello, World

Its great to be here!


import React from 'react';
import ReactDOM from 'react-dom';
import HelloWorld from './';

ReactDOM.Render(<HelloWorld />, document.getElementById('app'));


You can write ES6 imports inline using front matter.

imports: |
  import { SomeComponent } from './SomeComponent';

# Hello, World

Heres a component rendered inline:

<SomeComponent />

Controlling JavaScript

You can pass simple props to components. However, if you need to write more advanced JavaScript, its recommended to declare it in the imports section.


imports: | import { SomeComponent } from './SomeComponent';
const dynamic = () => import('./SomeComponent');
console.log('You can put anything here!'); ---

Anything added to the `imports` front matter is added between the React import and component declaration in the outputted module.

## Syntax Highlighting

Syntax highlighting is done using PrismJS and is picked up automatically by tagging code blocks:


    # Code Sample

    console.log('This will be marked for highlighting');

## Extra Data

Any front matter that is not under the `imports` key is considered extra data. It is parsed and exported as named exports from the module.

title: Hello World
slug: /post/1
    - foo: bar
    - baz: biz
    - foo
    - bar

The above front matter is transformed to:
const title = "Hello World";
export { title };

const slug = "/post/1";
export { slug };

const object = [{ foo: "bar" }, { baz: "biz" }];
export { object };

const array = ["foo", "bar"];
export { array };