markdownlint-rule-enhanced-proper-names

0.0.1 • Public • Published

markdownlint-rule-enhanced-proper-names

npm

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": [
        ...
      ]
    }
  }
}

Readme

Keywords

Package Sidebar

Install

npm i markdownlint-rule-enhanced-proper-names

Weekly Downloads

64

Version

0.0.1

License

MIT

Unpacked Size

7.04 kB

Total Files

4

Last publish

Collaborators

  • xiaogaozi