markdownlint-rule-enhanced-proper-names v0.0.1

markdownlint-rule-enhanced-proper-names

Enhanced MD044/proper-names rule for markdownlint. The difference from the original version is:

• Add heading_id parameter (default true): set to false to disable the rule for custom heading ID (e.g. # Heading {#custom-heading-id})

Installation

yarn add markdownlint-rule-enhanced-proper-names

Usage

Edit .markdownlint-cli2.jsonc, add markdownlint-rule-enhanced-proper-names to customRules:

{
  "customRules": [
    "markdownlint-rule-enhanced-proper-names/src/enhanced-proper-names.js"
  ],
  "config": {
    "enhanced-proper-names": {
      "code_blocks": true,
      "html_elements": true,
      "heading_id": true,
      "names": [
        ...
      ]
    }
  }
}