markdownlint-cli2

markdownlint-cli2

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library

Install

As a global CLI:

npm install markdownlint-cli2 --global

As a development dependency of the current [Node.js][nodejs] package:

npm install markdownlint-cli2 --save-dev

As a [Docker][docker] container image:

docker pull davidanson/markdownlint-cli2

As a global CLI with [Homebrew][homebrew]:

brew install markdownlint-cli2

As a [GitHub Action][github-action] via [markdownlint-cli2-action][markdownlint-cli2-action]:

- name: markdownlint-cli2-action
  uses: DavidAnson/markdownlint-cli2-action@main

Overview

• [markdownlint][markdownlint] is a library for linting [Markdown][markdown]/

[CommonMark][commonmark] files on [Node.js][nodejs] using the [markdown-it][markdown-it] parser.

• [markdownlint-cli][markdownlint-cli] is a traditional command-line interface

for markdownlint.