Grunt-md-link-checker NPM

grunt-md-link-checker

Check links in markdown even github private ones - Grunt Wrapper

Getting Started

This plugin requires Grunt ~1.0.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-md-link-checker --save-dev

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

grunt.loadNpmTasks('grunt-md-link-checker');

The "md_link_checker" task

Overview

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

grunt.initConfig({
  md_link_checker: {
      src: ['./README.md'],
      options: {
        tokenFilePath: '~/.token'
      }
  }
});

The token file should look like this:

{
    "token": "yourGitHubToken"
}

You can also omit the tokenFilePath, but then you can not check private GitHub links.

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.