@ivuorinen/markdownlint-config

ivuorinen's shareable configuration for MarkdownLint.

Table of Contents

• Installation
• Documentation
• Contributing
• Changelog
• License

Installation

Install this config as a devDependencies:

# npm
npm install @ivuorinen/markdownlint-config --save-dev

# Yarn
yarn add @ivuorinen/markdownlint-config --dev

Create a .markdownlint.json in the project's root folder with the following configuration:

{
  "extends": "@ivuorinen/markdownlint-config"
}

With npm, a postinstall script writes exactly this file when the project has no markdownlint config yet (npm 11 warns that the script is not covered by allowScripts). Yarn 4 does not run dependency install scripts, so no file is written. pnpm refuses unapproved install scripts and fails the install until you allow this package with pnpm approve-builds. In both cases create the file by hand as above.

Requires Node.js ^22.22.2 || ^24.15.0 || >=26, the floor of the bundled markdownlint-cli.

Documentation

Read the MarkdownLint docs for more information.

Contributing

If you are interested in helping contribute, please open an issue or pull request.

Changelog

See CHANGELOG for a human-readable history of changes.

License

Distributed under the MIT License. See LICENSE for more information.