2022-10-30 15:13:19 -07:00
|
|
|
# `MD020` - No space inside hashes on closed atx style heading
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `atx_closed`, `headers`, `headings`, `spaces`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `no-missing-space-closed-atx`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-12-16 13:53:03 -08:00
|
|
|
Fixable: Some violations can be fixed by tooling
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
This rule is triggered when spaces are missing inside the hash characters
|
|
|
|
in a closed atx style heading:
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
#Heading 1#
|
|
|
|
|
|
|
|
##Heading 2##
|
|
|
|
```
|
|
|
|
|
|
|
|
To fix this, separate the heading text from the hash character by a single
|
|
|
|
space:
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
# Heading 1 #
|
|
|
|
|
|
|
|
## Heading 2 ##
|
|
|
|
```
|
|
|
|
|
|
|
|
Note: this rule will fire if either side of the heading is missing spaces.
|
|
|
|
|
|
|
|
Rationale: Violations of this rule can lead to improperly rendered content.
|