Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 22:10:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update MD003 to support setext_with_atx.

Browse source
This commit is contained in:
David Anson 2015-07-29 22:17:33 -07:00
parent c2aff32460
commit fd1215d143
4 changed files with 33 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/Rules.md
View file

@ -53,7 +53,7 @@ The first header in the document should be a h1 header:
Tags: headers
Parameters: style ("consistent", "atx", "atx_closed", "setext"; default "consistent")
Parameters: style ("consistent", "atx", "atx_closed", "setext", "setext_with_atx"; default "consistent")
This rule is triggered when different header styles (atx, setext, and 'closed'
atx) are used in the same document:
@ -71,9 +71,20 @@ Be consistent with the style of header used in a document:
## ATX style H2
The setext_with_atx doc style allows 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), or simply require that the usage be consistent within the
document.
atx_closed, setext, setext_with_atx), or simply require that the usage be
consistent within the document.
## MD004 - Unordered list style