Awesome

grunt-markdownlint

A grunt task for markdown style checker and lint tool.

• Overview
• Usage
• Installation
• API Documentation
• Contributing
• Release History
• License

<a name="overview"></a>

Overview

The markdownlint grunt plugin enables to run rule based linting on your project markdown files.

See markdownlint for more information.

For linting rules, please see Rules document.

<a name="usage"></a>

Usage

In order to use the markdownlint plugin, please use following example:

//to use via grunt, first load the task
require('load-grunt-tasks')(grunt); // npm install --save-dev load-grunt-tasks
//or load it manually
grunt.loadNpmTasks('grunt-markdownlint');

grunt.initConfig({
  markdownlint: {
    example1: {
      options: {
        config: { //configure the linting rules
          'default': true,
          'line-length': false,
          'blanks-around-headers': false,
          'no-duplicate-header': false,
          'no-inline-html': false
        }
      },
      src: [
        'README.md',
        '.github/*.md'
      ]
    },
    example2: {
      options: {
        config: grunt.file.readJSON(rulesFile) //read linting rules from file
      },
      src: [
        'README.md',
        '.github/*.md'
      ]
    }
  }
});

grunt.registerTask('default', ['markdownlint:example1']);

The different options are defined in the markdownlint api documentation.

<a name="installation"></a>

Installation

In order to use this library, just run the following npm install command:

npm install --save-dev grunt-markdownlint

API Documentation

See full docs at: API Docs

Contributing

See contributing guide

<a name="history"></a>

Release History

<a name="license"></a>

License

Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.