2022-10-30 15:13:19 -07:00
|
|
|
# `MD035` - Horizontal rule style
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Tags: `hr`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
2022-10-30 15:13:19 -07:00
|
|
|
Aliases: `hr-style`
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
2022-11-13 20:53:10 -08:00
|
|
|
- `style`: Horizontal rule style (`string`, default `consistent`)
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
This rule is triggered when inconsistent styles of horizontal rules are used
|
|
|
|
in the document:
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
---
|
|
|
|
|
|
|
|
- - -
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
|
|
* * *
|
|
|
|
|
|
|
|
****
|
|
|
|
```
|
|
|
|
|
2024-10-07 22:08:16 -07:00
|
|
|
To fix this, use the same horizontal rule everywhere:
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
```markdown
|
|
|
|
---
|
|
|
|
|
|
|
|
---
|
|
|
|
```
|
|
|
|
|
2024-10-07 22:08:16 -07:00
|
|
|
The configured style can ensure all horizontal rules use a specific string or it
|
|
|
|
can ensure all horizontal rules match the first horizontal rule (`consistent`).
|
2022-10-29 23:21:45 -07:00
|
|
|
|
|
|
|
Rationale: Consistent formatting makes it easier to understand a document.
|