mdlint

mdlint

Lint JavaScript code blocks in markdown files to find syntax errors.

Installation

npm install -g mdlint

Usage

mdlint is used as a command-line utility. You lint a set of local markdown files matched by a glob, a GitHub repository's README, or query the GitHub API to go bounty hunting for syntax errors.

mdlint <command> <arg(s)> [options]

Commands:

repo  <user/repo>            lints a README from a GitHub repo
user <GitHub username>       lints all READMEs from a user's GitHub repos
glob  <fileGlob>             lints local markdown files that match a file glob
query <queryString> [page]   lints READMEs from repos returned by a GitHub query

Options:

-s, --silent   only report failing lints
-h, --help     output usage information
-V, --version  output the version number

Here is an example of mdlint being run on a GitHub repo's README file:

mdlint repo ChrisWren/grunt-pages

Here is an example of mdlint being run on all READMEs from a user's GitHub repos:

mdlint user ChrisWren

Here is an example of mdlint being run on a set of local files:

mdlint glob docs/*.md

Here is an example of mdlint being run on a collection of READMEs returned from the grunt GitHub repositories search query:

mdlint query grunt

Accepted Psuedocode

mdlint accepts certain pre-defined psuedocode which it will preprocess so that an error isn't thrown during syntax validation.

Object pseudocode

gruntplugin: {
  
}

{
  key: 'value'
}

Function pseudocode

function () {
  
}

Changelog

0.0.1 - Added user command.

0.0.0 - Initial Release.