Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.15 KB

md034.md

File metadata and controls

50 lines (34 loc) · 1.15 KB

MD034 - Bare URL used

Tags: links, url

Aliases: no-bare-urls

Fixable: Some violations can be fixed by tooling

This rule is triggered whenever a URL or email address appears without surrounding angle brackets:

For more info, visit https://www.example.com/ or email [email protected].

To fix this, add angle brackets around the URL or email address:

For more info, visit <https://www.example.com/> or email <[email protected]>.

Note: To include a bare URL or email without it being converted into a link, wrap it in a code span:

Not a clickable link: `https://www.example.com`

Note: The following scenario does not trigger this rule because it could be a shortcut link:

[https://www.example.com]

Note: The following syntax triggers this rule because the nested link could be a shortcut link (which takes precedence):

[text [shortcut] text](https://example.com)

To avoid this, escape both inner brackets:

[link \[text\] link](https://example.com)

Rationale: Without angle brackets, a bare URL or email isn't converted into a link by some Markdown parsers.