mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-21 21:30:47 +02:00
Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.
This commit is contained in:
parent
32c75ebfd9
commit
37baddcf27
110 changed files with 3875 additions and 179 deletions
42
doc/md035.md
Normal file
42
doc/md035.md
Normal file
|
@ -0,0 +1,42 @@
|
|||
# MD035 - Horizontal rule style
|
||||
|
||||
Tags: hr
|
||||
|
||||
Aliases: hr-style
|
||||
|
||||
Parameters:
|
||||
|
||||
* `style`: Horizontal rule style (`string`, default `consistent`)
|
||||
|
||||
This rule is triggered when inconsistent styles of horizontal rules are used
|
||||
in the document:
|
||||
|
||||
```markdown
|
||||
---
|
||||
|
||||
- - -
|
||||
|
||||
***
|
||||
|
||||
* * *
|
||||
|
||||
****
|
||||
```
|
||||
|
||||
To fix this, ensure any horizontal rules used in the document are consistent,
|
||||
or match the given style if the rule is so configured:
|
||||
|
||||
```markdown
|
||||
---
|
||||
|
||||
---
|
||||
```
|
||||
|
||||
Note: by default, this rule is configured to just require that all horizontal
|
||||
rules in the document are the same and will trigger if any of the horizontal
|
||||
rules are different than the first one encountered in the document. If you
|
||||
want to configure the rule to match a specific style, the parameter given to
|
||||
the 'style' option is a string containing the exact horizontal rule text that
|
||||
is allowed.
|
||||
|
||||
Rationale: Consistent formatting makes it easier to understand a document.
|
Loading…
Add table
Add a link
Reference in a new issue