@kitschpatrol/markdownlint-config

@kitschpatrol/markdownlint-config

Overview

It's a shared markdownlint config.

See @kitschpatrol/shared-config for the recommended single-package approach.

Setup

To use just this markdownlint config in isolation:

• Install the .npmrc in your project root. This is required for correct PNPM behavior:

  pnpm dlx @kitschpatrol/npm-config
  

• Add the package:

  pnpm add -D @kitschpatrol/markdownlint-config
  

• Add the starter .markdownlint.json file to your project root, and add any customizations you'd like:

  pnpm exec markdownlint-config --init
  

Usage

The markdownlint binary should be picked up automatically by VSCode plugins.

You can call it directly, or use the script bundled with the config.

Integrate with your package.json scripts as you see fit, for example:

...
"scripts": {
  "lint": "markdownlint-config"
}
...

Notes

Ignores files in .gitignore