grunt-marked

Plugin that compiles markdown files into html, using marked parser.

Getting Started

This plugin requires Grunt >=0.4.2

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-marked --save-dev

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

grunt.loadNpmTasks('grunt-marked');

The "marked" task

Overview

In your project's Gruntfile, add a section named marked to the data object passed into grunt.initConfig().

grunt.initConfig({
  marked: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

Grunt-marked uses the default marked parser options. But, it also use some other options:

options.highlight

Type: Boolean Default value: TRUE

A boolean flag that shows, use highlight.js plugin or not to highlight the syntax.

options.renderer

Type: Object Default value: marked.Renderer

Renderer to use.

Usage Examples

Default Options

In this example, the default options are used to compile markdown files.

grunt.initConfig({
  marked: {
    dist: {
      files: {
        'dest/my.html': ['src/my.md', 'src/header.md'],
      }
    }
  },
});

Custom Options

In this example, custom options are used to compile markdown files.

grunt.initConfig({
  marked: {
    options: {
      highlight: false,
      gfm: true,
      tables: true,
      breaks: false,
      pedantic: false,
      sanitize: true,
      smartLists: true,
      smartypants: false
    },
    dist: {
      files: {
        'dest/my.html': 'src/my.md',
        'dest/some.html': 'src/some.md'
      }
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

2014-02-26 v0.1.0 Initial release.

gobwas/grunt-marked