feat: use go tool
This commit is contained in:
+59
@@ -0,0 +1,59 @@
|
||||
# `MD003` - Heading style
|
||||
|
||||
Tags: `headings`
|
||||
|
||||
Aliases: `heading-style`
|
||||
|
||||
Parameters:
|
||||
|
||||
- `style`: Heading style (`string`, default `consistent`, values `atx` /
|
||||
`atx_closed` / `consistent` / `setext` / `setext_with_atx` /
|
||||
`setext_with_atx_closed`)
|
||||
|
||||
This rule is triggered when different heading styles are used in the same
|
||||
document:
|
||||
|
||||
```markdown
|
||||
# ATX style H1
|
||||
|
||||
## Closed ATX style H2 ##
|
||||
|
||||
Setext style H1
|
||||
===============
|
||||
```
|
||||
|
||||
To fix the issue, use consistent heading styles throughout the document:
|
||||
|
||||
```markdown
|
||||
# ATX style H1
|
||||
|
||||
## ATX style H2
|
||||
```
|
||||
|
||||
The `setext_with_atx` and `setext_with_atx_closed` settings allow ATX-style
|
||||
headings of level 3 or more in documents with setext-style headings (which only
|
||||
support level 1 and 2 headings):
|
||||
|
||||
```markdown
|
||||
Setext style H1
|
||||
===============
|
||||
|
||||
Setext style H2
|
||||
---------------
|
||||
|
||||
### ATX style H3
|
||||
```
|
||||
|
||||
Note: The configured heading style can be a specific style to require (`atx`,
|
||||
`atx_closed`, `setext`, `setext_with_atx`, `setext_with_atx_closed`), or can
|
||||
require that all heading styles match the first heading style via `consistent`.
|
||||
|
||||
Note: The placement of a horizontal rule directly below a line of text can
|
||||
trigger this rule by turning that text into a level 2 setext-style heading:
|
||||
|
||||
```markdown
|
||||
A line of text followed by a horizontal rule becomes a heading
|
||||
---
|
||||
```
|
||||
|
||||
Rationale: Consistent formatting makes it easier to understand a document.
|
||||
Reference in New Issue
Block a user