no-missing-atx-heading-space

This rule warns when spaces are missing after the hash characters in an ATX style heading.

Rule Details

In Markdown, headings can be created using ATX style (using hash (#) characters at the beginning of the line) or Setext style (using underlining with equals (=) or hyphens (-)).

For ATX style headings, a space should be used after the hash characters to improve readability and ensure proper rendering across various Markdown parsers.

This rule is automatically fixable by the --fix command line option.

Examples of incorrect code for this rule:

<!-- eslint markdown/no-missing-atx-heading-space: "error" -->

#Heading 1
##Heading 2
###Heading 3

Examples of correct code for this rule:

<!-- eslint markdown/no-missing-atx-heading-space: "error" -->

# Heading 1
## Heading 2
### Heading 3

<h1>#Some Heading</h1>

[#123](link.com)

![#alttext][link.png]

This is a paragraph with a #hashtag, not a heading.

When Not To Use It

You might want to turn this rule off if you're working with a Markdown variant that doesn't require spaces after hash characters in headings.

Prior Art

MD018 - No space after hash on atx style heading

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!