@kcuf/markdownlint-config v0.0.2

@kcuf/markdownlint-config

A shareable markdown lint config, which can be used with markdownlint-cli or markdownlint-cli2.

Inherit

@kcuf/markdownlint-config ← BASE

Install & Setup

pnpm add -D markdownlint-cli2 @kcuf/markdownlint-config

In your .markdownlint.yaml:

extends: "@kcuf/markdownlint-config"

Usage

Terminal

With lint-staged (Recommended 💎)

{
  "*.md": "markdownlint-cli2"
}

npx markdownlint-cli2 ./README.md

npm-scripts

npm pkg set scripts.lint:md="markdownlint-cli2 **/*.md #node_modules"