Skip to content
Complete LogoComplete

markdownlint-rule-complete

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

Installation

Section titled “Installation”
Terminal window
npm install --save-dev markdownlint-rule-complete

Usage

Section titled “Usage”

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

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

Rules

Section titled “Rules”
Name Description Fixable
extended-ascii Requires text to contain only ASCII characters, with limited exceptions
no-bold-headers Disallows bold text in headings Yes
no-code-block-newlines Disallows leading and trailing blank lines inside fenced code blocks Yes
no-cspell-words Disallows CSpell words directives
no-horizontal-rules Disallows horizontal rules Yes
no-image-alt-text Disallows image alt text Yes
no-redundant-links Disallows links whose text is identical to their URL
no-space-before-punctuation Disallows spaces before periods and commas Yes
no-unconventional-code-blocks Requires conventional language identifiers for fenced code blocks Yes