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

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

30
doc/md011.md Normal file
View file

@ -0,0 +1,30 @@
# MD011 - Reversed link syntax
Tags: links
Aliases: no-reversed-links
Fixable: Most violations can be fixed by tooling
This rule is triggered when text that appears to be a link is encountered, but
where the syntax appears to have been reversed (the `[]` and `()` are
reversed):
```markdown
(Incorrect link syntax)[https://www.example.com/]
```
To fix this, swap the `[]` and `()` around:
```markdown
[Correct link syntax](https://www.example.com/)
```
Note: [Markdown Extra](https://en.wikipedia.org/wiki/Markdown_Extra)-style
footnotes do not trigger this rule:
```markdown
For (example)[^1]
```
Rationale: Reversed links are not rendered as usable links.