Giter Site home page Giter Site logo

markdown-it-loader's Introduction

markdown-it loader for webpack Version Build Status Dependency Status

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'
    }]
  },

  'markdown-it': {
    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'
    }]
  },

  'markdown-it': {
    preset: 'default',
    typographer: true,
    use: [subscript, superscript, [container, "contained"]]
  }
};

Meta

Contributors

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 People

Contributors

greenkeeperio-bot avatar posva avatar unindented avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.