mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.
This commit is contained in:
parent
32c75ebfd9
commit
37baddcf27
110 changed files with 3875 additions and 179 deletions
44
doc/md034.md
Normal file
44
doc/md034.md
Normal file
|
@ -0,0 +1,44 @@
|
|||
# MD034 - Bare URL used
|
||||
|
||||
Tags: links, url
|
||||
|
||||
Aliases: no-bare-urls
|
||||
|
||||
Fixable: Most violations can be fixed by tooling
|
||||
|
||||
This rule is triggered whenever a URL is given that isn't surrounded by angle
|
||||
brackets:
|
||||
|
||||
```markdown
|
||||
For more information, see https://www.example.com/.
|
||||
```
|
||||
|
||||
To fix this, add angle brackets around the URL:
|
||||
|
||||
```markdown
|
||||
For more information, see <https://www.example.com/>.
|
||||
```
|
||||
|
||||
Note: To use a bare URL without it being converted into a link, enclose it in
|
||||
a code block, otherwise in some Markdown parsers it *will* be converted:
|
||||
|
||||
```markdown
|
||||
`https://www.example.com`
|
||||
```
|
||||
|
||||
Note: The following scenario does *not* trigger this rule to avoid conflicts
|
||||
with `MD011`/`no-reversed-links`:
|
||||
|
||||
```markdown
|
||||
[https://www.example.com]
|
||||
```
|
||||
|
||||
The use of quotes around a bare link will *not* trigger this rule, either:
|
||||
|
||||
```markdown
|
||||
"https://www.example.com"
|
||||
'https://www.example.com'
|
||||
```
|
||||
|
||||
Rationale: Without angle brackets, the URL isn't converted into a link by many
|
||||
Markdown parsers.
|
Loading…
Add table
Add a link
Reference in a new issue