mochajs/markdownlint-cli

Name: markdownlint-cli

Owner: Mocha

Description: MarkdownLint Command Line Interface

Forked from: igorshubovych/markdownlint-cli

Created: 2017-12-21 21:49:32.0

Updated: 2018-01-03 22:59:49.0

Pushed: 2017-12-22 00:05:33.0

Homepage: null

Size: 73

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

markdownlint-cli

Command Line Interface for MarkdownLint

Installation

install -g markdownlint-cli

Usage

rkdownlint --help

age: markdownlint [options] <files>

rkdownLint Command Line Interface

tions:

-h, --help                 output usage information
-V, --version              output the version number
-c, --config [configFile]  Configuration file

Configuration

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:

efault": true,
D003": { "style": "atx_closed" },
D007": { "indent": 4 },
o-hard-tabs": false,
hitespace": 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.

Related

• markdownlint - API for this module

License

MIT © Igor Shubovych