Skip to main content

markdownlint-config-complete

Introduction​

This is a sharable configuration for markdownlint. It disables rules that are redundant with Prettier and markdownlint-rule-complete.

Install​

For example, if you use the npm package manager:

npm install --save-dev markdownlint-cli2 markdownlint-config-complete

Usage​

Add the package name to the extends property inside of config in .markdownlint-cli2.jsonc:

{
  "config": {
    "extends": "markdownlint-config-complete",
  },
}

Project-specific settings override the shared config:

{
  "config": {
    "extends": "markdownlint-config-complete",
    "MD013": true,
  },
}

Custom rules are distributed separately by markdownlint-rule-complete. Both packages can be used together:

{
  "config": {
    "extends": "markdownlint-config-complete",
  },
  "customRules": ["markdownlint-rule-complete"],
}

Disabled Rules​

  • MD009 (trailing spaces): Prettier handles this check.
  • MD010 (hard tabs): Prettier handles this check.
  • MD012 (multiple consecutive blank lines): Prettier handles this check.
  • MD013 (line length): Prettier does not automatically break long Markdown lines, so an arbitrary limit is undesirable.
  • MD022 (headings should be surrounded by blank lines): Prettier handles this check.
  • MD031 (fenced code blocks should be surrounded by blank lines): Prettier handles this check.
  • MD032 (lists should be surrounded by blank lines): Prettier handles this check.
  • MD045 (images should have alternate text): Conflicts with markdownlint-rule-complete/no-image-alt-text.
  • MD047 (files should end with a single newline): Prettier handles this check.
  • MD060 (table column style): Prettier handles this check.