A grunt task for markdown style checker and lint tool.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
project/config
tasks
test/spec
.editorconfig
.eslintrc.js
.gitattributes
.gitignore
.jsbeautifyrc
.jscs.json
.jshintrc
.jslintrc
.npmignore
.travis.yml
Gruntfile.js
LICENSE
README.md
inch.json
index.js
package.json
stylelint.config.js

README.md

grunt-markdownlint

NPM Version Build Status Coverage Status Known Vulnerabilities Inline docs
License Total Downloads Dependency Status devDependency Status

A grunt task for markdown style checker and lint tool.

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.

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.

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

Release History

Date Version Description
2018-07-22 v2.1.0 Maintenance
2018-06-07 v2.0.0 Upgrade markdownlint and minimal node version
2018-05-29 v1.1.6 Upgrade markdownlint version
2016-11-04 v1.0.11 Support new markdownlint 0.3.0 options
2016-07-01 v0.1.0 Updated task config to use options
2016-06-14 v0.0.5 Initial release

License

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