Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update rule documentation to explain how consistent is implemented (fixes #1346).

Browse source
This commit is contained in:
David Anson 2024-10-07 22:08:16 -07:00
parent 61a9c2427e
commit 5faa6f4235
17 changed files with 75 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/md003.md
View file

@ -45,8 +45,8 @@ Setext style H2
```
Note: The configured heading style can be a specific style to require (`atx`,
`atx_closed`, `setext`, `setext_with_atx`, `setext_with_atx_closed`), or may
just require that usage is consistent within the document via `consistent`.
`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: