markdownlint-cli
Command Line Interface for MarkdownLint
Installation
npm install -g markdownlint-cli
Usage
$ markdownlint --help Usage: markdownlint [options] <files|directories|globs> MarkdownLint Command Line Interface Options: -h, --help output usage information -V, --version output the version number -s, --stdin read from STDIN -o, --output [outputFile] write issues to file -c, --config [configFile] configuration file -i, --ignore [file|directory|glob] files to ignore/exclude -r, --rules [file|directory|glob|package] custom rule files
Configuration
markdownlint-cli
reuses the rules from markdownlint
package.
Configuration is stored in JSON, YAML or INI files in the same config format.
The example of configuration file:
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
/.markdownlint.yaml
/.markdownlint.yml
in current folder, or for file .markdownlintrc
in current or all upper folders. The algorithm is described in details on rc package page. If --config
argument is provided, the file must be valid JSON or YAML.
Related
- markdownlint - API for this module
- glob - Pattern matching implementation
License
MIT © Igor Shubovych