mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-24 01:40:13 +01:00
39 lines
950 B
Markdown
39 lines
950 B
Markdown
|
# MD003 - Header style
|
||
|
|
|
||
|
|
Tags: headers
|
||
|
|
|
||
|
|
Aliases: header-style
|
||
|
|
|
||
|
|
Parameters: style ("consistent", "atx", "atx_closed", "setext",
|
||
|
|
"setext_with_atx", "setext_with_atx_closed"; default "consistent")
|
||
|
|
|
||
|
|
This rule is triggered when different header styles (atx, setext, and 'closed'
|
||
|
|
atx) are used in the same document:
|
||
|
|
|
||
|
|
# ATX style H1
|
||
|
|
|
||
|
|
## Closed ATX style H2 ##
|
||
|
|
|
||
|
|
Setext style H1
|
||
|
|
===============
|
||
|
|
|
||
|
|
Be consistent with the style of header used in a document:
|
||
|
|
|
||
|
|
# ATX style H1
|
||
|
|
|
||
|
|
## ATX style H2
|
||
|
|
|
||
|
|
The setext_with_atx and settext_with_atx_closed doc styles allow atx-style
|
||
|
|
headers of level 3 or more in documents with setext style headers:
|
||
|
|
|
||
|
|
Setext style H1
|
||
|
|
===============
|
||
|
|
|
||
|
|
Setext style H2
|
||
|
|
---------------
|
||
|
|
|
||
|
|
### ATX style H3
|
||
|
|
|
||
|
|
Note: the configured header style can be a specific style to use (atx,
|
||
|
|
atx_closed, setext, setext_with_atx, setext_with_atx_closed), or simply require
|
||
|
|
that the usage be consistent within the document.
|