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

Deprecate MD002/first-heading-h1 in favor of MD041/first-line-h1 (refs #169).

Browse source
This commit is contained in:
David Anson 2019-03-12 22:23:12 -07:00
parent c71bb4fbd5
commit 0184f9d618
11 changed files with 42 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/Rules.md
View file

@ -51,6 +51,9 @@ Aliases: first-heading-h1, first-header-h1
Parameters: level (number; default 1)
> Note: *MD002 has been deprecated and is disabled by default.*
> [MD041](#md041) offers an improved implementation of the rule.
This rule is intended to ensure document headings start at the top level and
is triggered when the first heading in the document isn't an h1 heading:
@ -71,8 +74,6 @@ The first heading in the document should be an h1 heading:
Note: The `level` parameter can be used to change the top level (ex: to h2) in
cases where an h1 is added externally.
See also: [MD041](#md041) for an improved version of this rule.
<a name="md003"></a>
## MD003 - Heading style