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

Add level parameter to MD002/MD025/MD041 (fixes #19).

Browse source
This commit is contained in:
David Anson 2016-07-04 23:23:29 -07:00
parent 7a1773ea77
commit f2060b4607
6 changed files with 51 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/Rules.md
View file

@ -34,12 +34,14 @@ level at a time:
### Another Header 3
## MD002 - First header should be a h1 header
## MD002 - First header should be a top level header
Tags: headers
Aliases: first-header-h1
Parameters: level (number; default 1)
This rule is triggered when the first header in the document isn't a h1 header:
## This isn't a H1 header
@ -52,6 +54,9 @@ The first header in the document should be a h1 header:
## Then use a H2 for subsections
Note: The `level` parameter can be used to change the top level (ex: to h2) in
cases where an h1 is added externally.
## MD003 - Header style
Tags: headers
@ -535,6 +540,8 @@ Tags: headers
Aliases: single-h1
Parameters: level (number; default 1)
This rule is triggered when a top level header is in use (the first line of
the file is a h1 header), and more than one h1 header is in use in the
document:
@ -558,6 +565,9 @@ serves as the title for the document. If this convention is in use, then there
can not be more than one title for the document, and the entire document
should be contained within this header.
Note: The `level` parameter can be used to change the top level (ex: to h2) in
cases where an h1 is added externally.
## MD026 - Trailing punctuation in header
Tags: headers
@ -1001,6 +1011,8 @@ Tags: headers
Aliases: first-line-h1
Parameters: level (number; default 1)
This rule is triggered when the first line in the file isn't a top level (h1)
header:
@ -1016,6 +1028,9 @@ To fix this, add a header to the top of your file:
This is a file with a top level header
```
Note: The `level` parameter can be used to change the top level (ex: to h2) in
cases where an h1 is added externally.
## MD042 - No empty links
Tags: links