grunt-markdown-it

Small wrapper for markdown-it. Converts *.md files to .html files.

• Syntax highlighting support
• Works with many markdown-it plugins

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-markdown-it --save-dev

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-markdown-it');

Usage

grunt.initConfig({
  markdownit: {
    options: {
      // markdown-it options here
    },
    target: {
      // target-specific file lists and/or options go here.
    },
  },
})

Options

Possible options are as follows:

options.highlightjs

Type: boolean Default: false

Easy way to enable parsing of code blocks for syntax highlighting with highlight.js. Alternatively you may use markdown-it's highlight property, or the options.plugins property, to implement a different syntax highlighting soluton.

Note: If set to true, make sure highlight.js is installed. You will also need to include the highlight.js script and desired styles. See highlight.js usage for details.

options.prefix

Type: string Default: <pre class="hljs"><code class="{{langClass}}">

Simple way to override the default opening tag(s) for a code block. Make sure to use with options.suffix.

options.suffix

Type: string Default: </code></pre>

Simple way to override the default closing tag(s) for a code block. Make sure to use with options.prefix.

options.plugins

Type: object Default: null

There are two ways to use markdown-it plugins. For each plugin, use the plugin name for the object key, and either an object or function as the value.

This example shows both ways of using a plugin:

options: {
    plugins: {
        'markdown-it-anchor': {
            level: 1
        },
        'markdown-it-table-of-contents': {
            includeLevel: [2,3],
            containerClass: 'toc-test',
        },
        'markdown-it-attrs': {},
        'markdown-it-container': function (md) {
            var container = require('markdown-it-container');
            var tags = [];
            md.use(container, 'html', {
                validate: function (name) {
                    return name.trim().match(/([a-z]+)?\(.*\)/);
                },
                render: function (tokens, idx) {
                    if (tokens[idx].nesting === 1) {
                        var info = tokens[idx].info.trim();
                        var attrs = info.match(/\(.*\)/) ? info.match(/\(.*\)/)[0] : null;
                        var tag = info.split('(')[0];
                        tags.push(tag);
                        return '<' + tag + (attrs ?  ' ' + attrs.slice(1, attrs.length - 1) : '') + '>\n';
                    } else {
                        var html = '</' + tags[tags.length - 1] + '>\n';
                        tags.pop();
                        return html;
                    }
                }
            });
        }
    }
}

options.*

Any option not specified above is passed directly to markdown-it.

Release History

• 0.2.1: Ability to use any [markdown-it](https://github.com/markdown-it/markdown-it) plugin.
• 0.1.1: Initial release.

To Do:

• [x] Integrate markdown-it plugins that might have multiple arguments.

License

(c) 2016 The Zimmee Licensed under the MIT License