Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-02-15 09:58:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.

Browse source
This commit is contained in:
David Anson 2022-10-29 23:21:45 -07:00
parent 32c75ebfd9
commit 37baddcf27
110 changed files with 3875 additions and 179 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc-build/md002.md Normal file
View file

@ -0,0 +1,25 @@
> Note: *MD002 has been deprecated and is disabled by default.*
> [MD041/first-line-heading](md041.md) offers an improved implementation.
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:
```markdown
## This isn't an H1 heading
### Another heading
```
The first heading in the document should be an h1 heading:
```markdown
# Start with an H1 heading
## Then use an 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.
Rationale: The top-level heading often acts as the title of a document. More
information: <https://cirosantilli.com/markdown-style-guide#top-level-header>.