Command Line Interface for MarkdownLint
npm install -g markdownlint-cli
$ markdownlint --help
Usage: markdownlint [options] <files|directories|globs>
MarkdownLint Command Line Interface
Options:
-h, --help output usage information
-V, --version output the version number
-c, --config [configFile] Configuration file
markdownlint-cli
reuses the rules from markdownlint
package.
Configuration is stored JSON or INI files in the same config format.
The example of configuration file:
{
"default": true,
"MD003": { "style": "atx_closed" },
"MD007": { "indent": 4 },
"no-hard-tabs": false,
"whitespace": false
}
See test configuration file or style folder for more examples.
CLI argument --config
is not mandatory. If it is not provided, markdownlint-cli
looks for file .markdownlint.json
in current folder, or for file .markdownlintrc
in current or all upper folders. The algorithm is described in details on rc package page.
- markdownlint - API for this module
- glob - Pattern matching implementation
MIT © Igor Shubovych