mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
Update README.md to clarify two things.
This commit is contained in:
parent
0006636f75
commit
1b0e783c33
2 changed files with 12 additions and 1 deletions
|
@ -70,6 +70,13 @@ and test cases came directly from that project.
|
||||||
[super-linter]: https://github.com/github/super-linter
|
[super-linter]: https://github.com/github/super-linter
|
||||||
[vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
|
[vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
|
||||||
|
|
||||||
|
### References
|
||||||
|
|
||||||
|
The following specifications are considered authoritative in cases of ambiguity:
|
||||||
|
|
||||||
|
- [CommonMark](https://spec.commonmark.org/current/)
|
||||||
|
- [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
|
||||||
|
|
||||||
## Demonstration
|
## Demonstration
|
||||||
|
|
||||||
[`markdownlint` demo](https://dlaa.me/markdownlint/), an interactive, in-browser
|
[`markdownlint` demo](https://dlaa.me/markdownlint/), an interactive, in-browser
|
||||||
|
@ -185,7 +192,7 @@ rules at once.
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Text passed to `markdownlint` is parsed as Markdown, analyzed, and any
|
Text passed to `markdownlint` is parsed as Markdown, analyzed, and any
|
||||||
issues reported. Two kinds of text are ignored:
|
issues reported. Two kinds of text are ignored by most rules:
|
||||||
|
|
||||||
- [HTML comments](https://www.w3.org/TR/html5/syntax.html#comments)
|
- [HTML comments](https://www.w3.org/TR/html5/syntax.html#comments)
|
||||||
- [Front matter](https://jekyllrb.com/docs/frontmatter/) (see
|
- [Front matter](https://jekyllrb.com/docs/frontmatter/) (see
|
||||||
|
|
|
@ -639,6 +639,7 @@ test("readmeHeadings", (t) => new Promise((resolve) => {
|
||||||
"## Install",
|
"## Install",
|
||||||
"## Overview",
|
"## Overview",
|
||||||
"### Related",
|
"### Related",
|
||||||
|
"### References",
|
||||||
"## Demonstration",
|
"## Demonstration",
|
||||||
"## Rules / Aliases",
|
"## Rules / Aliases",
|
||||||
"### Custom Rules",
|
"### Custom Rules",
|
||||||
|
@ -860,6 +861,7 @@ test("readme", (t) => new Promise((resolve) => {
|
||||||
t.falsy(err);
|
t.falsy(err);
|
||||||
const rulesLeft = [ ...rules ];
|
const rulesLeft = [ ...rules ];
|
||||||
let seenRelated = false;
|
let seenRelated = false;
|
||||||
|
let seenReferences = false;
|
||||||
let seenRules = false;
|
let seenRules = false;
|
||||||
let inRules = false;
|
let inRules = false;
|
||||||
let seenTags = false;
|
let seenTags = false;
|
||||||
|
@ -872,6 +874,8 @@ test("readme", (t) => new Promise((resolve) => {
|
||||||
) {
|
) {
|
||||||
if (!seenRelated) {
|
if (!seenRelated) {
|
||||||
seenRelated = true;
|
seenRelated = true;
|
||||||
|
} else if (!seenReferences) {
|
||||||
|
seenReferences = true;
|
||||||
} else if (!seenRules) {
|
} else if (!seenRules) {
|
||||||
seenRules = true;
|
seenRules = true;
|
||||||
inRules = true;
|
inRules = true;
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue