gm

grunt-markdownlint

A grunt task for markdown style checker and lint tool.

Showing:

Popularity

Downloads/wk

929

GitHub Stars

6

Maintenance

Last Commit

3mos ago

Contributors

5

Package

Dependencies

1

License

Apache-2.0

Type Definitions

Tree-Shakeable

No?

Categories

Readme

grunt-markdownlint

NPM Version CI Coverage Status Known Vulnerabilities Inline docs License Total Downloads

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

DateVersionDescription
2021-08-24v3.1.3Upgrade markdownlint version
2021-02-08v3.1.2Upgrade markdownlint version
2020-11-26v3.1.1Upgrade markdownlint version
2020-09-22v3.1.0Upgrade markdownlint version
2020-05-11v3.0.0Migrate to github actions and upgrade minimal node version
2020-04-13v2.10.0Upgrade markdownlint version
2018-06-07v2.0.0Upgrade markdownlint and minimal node version
2018-05-29v1.1.6Upgrade markdownlint version
2016-11-04v1.0.11Support new markdownlint 0.3.0 options
2016-07-01v0.1.0Updated task config to use options
2016-06-14v0.0.5Initial release

License

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial