Skip to main content

markdownlint-rule-complete

markdownlint-rule-complete is a collection of opinionated custom rules for markdownlint.

Installation

npm install --save-dev markdownlint-rule-complete

Usage

Add the package name to the customRules array in .markdownlint-cli2.jsonc:

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

Rules

NameDescriptionFixable
extended-asciiRequires text to contain only ASCII characters, with limited exceptions
no-bold-headersDisallows bold text in headingsYes
no-code-block-newlinesDisallows leading and trailing blank lines inside fenced code blocksYes
no-cspell-wordsDisallows CSpell words directives
no-horizontal-rulesDisallows horizontal rulesYes
no-image-alt-textDisallows image alt textYes
no-redundant-linksDisallows links whose text is identical to their URL
no-space-before-punctuationDisallows spaces before periods and commasYes
no-unconventional-code-blocksRequires conventional language identifiers for fenced code blocksYes