remark-loader

Remark Loader

Load markdown through remark with built-in image resolution.

Usage

Simply add the loader to your configuration, and pass options.

webpack.config.js

module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.md$/,
        use: [
          { 
            loader: 'remark-loader', 
            options: {
              plugins: [
                require('remark-kbd')
              ]
            }
          }
        ]
      }
    ]
  }
}

Here's the full list of remark plugins. Note that remark-html is always included as the last plugin and should not be included in the plugins list.

This loader makes use of the html-loader under the hood.

We no longer support any react specific features. Please see the wonderful MDX project if you're interested in mixing JSX with Markdown.

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Inspiration

This project was inspired the following open source work:

• react-markdown-loader
• marksy

License

MIT (c) 2017

Changelog

1.0.0-rc.0 (2019-06-10)

Chores

• remove react specific code (f4e64c4), closes #1

BREAKING CHANGES

• The react option has been removed. Our implementation was extremely hacky and led to a bunch of pitfalls. Please use MDX as an alternative.

<a name="0.3.2"></a>