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

Update README.md to clarify two things.

Browse source
This commit is contained in:
David Anson 2023-05-26 20:28:21 -07:00
parent 0006636f75
commit 1b0e783c33
2 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -70,6 +70,13 @@ and test cases came directly from that project.
[super-linter]: https://github.com/github/super-linter
[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
[`markdownlint` demo](https://dlaa.me/markdownlint/), an interactive, in-browser
@ -185,7 +192,7 @@ rules at once.
## Configuration
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)
- [Front matter](https://jekyllrb.com/docs/frontmatter/) (see