unindented/markdown-it-loader

Parse source as Markdown.

markdown-it loader for webpack

Parses source as Markdown using the awesome markdown-it parser.

By default, markdown-it-loader will highlight code blocks using highlight.js.

Installation

$ npm install --save markdown-it-loader markdown-it highlight.js

Usage

Documentation: Using loaders

In your webpack.config.js file:

var subscript = require('markdown-it-sub');
var superscript = require('markdown-it-sup');

module.exports = {
  module: {
    loaders: [{
      test:   /\.md/,
      loader: 'markdown-it',
      options: {
        preset: 'default',
        typographer: true,
        use: [subscript, superscript]
      }
    }]
  }
};

If you need to use a plugin that requires extra options such as markdown-it-container, you can use the following syntax:

var container = require('markdown-it-container');
var subscript = require('markdown-it-sub');
var superscript = require('markdown-it-sup');

module.exports = {
  module: {
    loaders: [{
      test:   /\.md/,
      loader: 'markdown-it',
      options: {
        preset: 'default',
        typographer: true,
        use: [subscript, superscript, [container, "contained"]]
      }
    }]
  }
};

Meta

• Code: git clone git://github.com/unindented/markdown-it-loader.git
• Home: https://github.com/unindented/markdown-it-loader/

Contributors

• Daniel Perez Alvarez ([email protected])

License

Copyright (c) 2014 Daniel Perez Alvarez (unindented.org). This is free software, and may be redistributed under the terms specified in the LICENSE file.

markdown-it-loader's Issues

Readme should give a note about highlight.js

Would be nice with instructions for how to include the highlight.js styles. At least, it should be noted that highlight.js is already included.

Should support markdown-it-container

Should also support other plugins that require options

List hightlight.js as optional peer dependency, for people that use prism instead

I like prism more, especially their themes, but when using markdown-it-prism, and thus removing highlight.js, beause I don't use it, there still is an error that it can't be found. It would be better if the loader will only use it if it's there, and otherwise doesn't use highlight.js, so in a sense, it would be an optional peer dependency. Currently it's confusing to see both prism and highlight.js in de dependency list.

markdown-it and highlight.js as peerDependencies?

With markdown-it and highlight.js as peer dependencies, one does not need to update markdown-it-loader when markdown-it and highlight.js updates. Also, it will allow for more flexible version control, if you want to stay on say markdown-it ^5.0.0.

Webpack 2?