markdownlint-cli
    Overview
    Documentation
    Tutorials
    Insights
    Code
    Dependencies
    Contributors
    Jobs

markdownlint-cli

MarkdownLint Command Line Interface

0.18.0  •  Updated 7 months ago  •  by Igor Shubovych  •  MIT License

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 (no files)
    -o, --output [outputFile]                   write issues to file (no console)
    -c, --config [configFile]                   configuration file (JSON or YAML)
    -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:

{
  "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/.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

License

MIT © Igor Shubovych

Popularity

Weekly Downloads
60.2K
Stars
239

Maintenance

Development

Last ver 7 months ago
Created 4 years ago
Last commit 5 months ago
9 days between commits

Technology

Node version: 10.15.3
13.5K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

15 contributors
David Anson
Maintainer, 83 commits, 13 merges, 2 PRs
Works at Microsoft Azure
Igor Shubovych
Maintainer, 54 commits, 3 merges
Works at Stuzo
David O'Trakoun
2 commits, 2 PRs
Works at squarespace
Aleksandr Veselov
2 commits, 2 PRs
Steve Dignam
1 commits, 1 PRs
Sequoia McDowell
1 commits, 1 PRs
Works at EventMobi

Tags

markdown
markdownlint
cli
cli-app
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.