eslint-plugin-markdown-preferences

Appearance

markdown-preferences/no-multi-spaces ​

disallow multiple spaces

  • ❗ This rule has not been released yet.
  • ⚙️ This rule is included in plugin.configs.standard.
  • 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

📖 Rule Details ​

This rule reports multiple consecutive spaces in Markdown content, except in cases where multiple spaces are meaningful or required by Markdown syntax (such as in code blocks, inline code, HTML, tables, frontmatter, or immediately after blockquote markers).

The purpose of this rule is to prevent unintentional extra spaces, which can make Markdown files harder to read and maintain, or cause inconsistent rendering across different viewers.

md
<!-- eslint markdown-preferences/no-multi-spaces: 'error' -->

<!-- ✓ GOOD -->

Lorem ipsum.

## Section Title

<!-- ✗ BAD -->

Lorem
   
ipsum.

##
   
Section
  
Title

Exceptions ​

This rule does not apply to code blocks, inline code, HTML, tables, frontmatter, or spaces immediately after blockquote markers.

  • Code blocks and inline code may require multiple spaces for their content.
  • HTML may require multiple spaces in some attribute values and/or content.
  • Tables may use multiple spaces for column alignment.
  • Frontmatter may require multiple spaces depending on the format.
  • Spaces immediately after blockquote markers are treated as indentation.

🛠 Options ​

This rule has no options.

🔍 Implementation ​