2022-10-30 15:13:19 -07:00
|
|
|
# `MD023` - Headings must start at the beginning of the line
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `headers`, `headings`, `spaces`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `header-start-left`, `heading-start-left`
|
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 a heading is indented by one or more spaces:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
Some text
|
|
|
|
|
|
|
|
|
|
# Indented heading
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To fix this, ensure that all headings start at the beginning of the line:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
Some text
|
|
|
|
|
|
|
|
|
|
# Heading
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Rationale: Headings that don't start at the beginning of the line will not be
|
|
|
|
|
parsed as headings, and will instead appear as regular text.
|
