Awesome Open Source
Awesome Open Source

markdown-loader

markdown-loader for webpack using marked.

install size Dependency Status Build Status

Installation

npm install markdown-loader

Changelog

Usage

Since marked's output is HTML, it's best served in conjunction with the html-loader.

Webpack 2+

{
    module: {
        rules: [{
                test: /\.md$/,
                use: [
                    {
                        loader: "html-loader"
                    },
                    {
                        loader: "markdown-loader",
                        options: {
                            /* your options here */
                        }
                    }
                ]
            }]
    }
}

Options

Pass your marked options as shown above. In order to specify custom renderers, set the options.renderer-option in your webpack config.

// webpack.config.js

const marked = require("marked");
const renderer = new marked.Renderer();

return {
    module: {
        rules: [{
                test: /\.md$/,
                use: [
                    {
                        loader: "html-loader"
                    },
                    {
                        loader: "markdown-loader",
                        options: {
                            pedantic: true,
                            renderer
                        }
                    }
                ]
            }]
    }
}

License

MIT (http://www.opensource.org/licenses/mit-license.php)

Sponsors


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (69,965
html (11,059
css (7,345
webpack (1,152
markdown (862
loader (164
webpack2 (110
webpack-loader (87