mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-16 22:10:13 +01:00
Add MD034 with tests, improve validation of README and Rules.
This commit is contained in:
parent
495fbac6fd
commit
0e24df7cf7
7 changed files with 104 additions and 34 deletions
22
doc/Rules.md
22
doc/Rules.md
|
|
@ -698,3 +698,25 @@ To fix this, use 'pure' markdown instead of including raw HTML:
|
|||
Rationale: Raw HTML is allowed in markdown, but this rule is included for
|
||||
those who want their documents to only include "pure" markdown, or for those
|
||||
who are rendering markdown documents in something other than HTML.
|
||||
|
||||
## MD034 - Bare URL used
|
||||
|
||||
Tags: links, url
|
||||
|
||||
This rule is triggered whenever a URL is given that isn't surrounded by angle
|
||||
brackets:
|
||||
|
||||
For more information, see http://www.example.com/.
|
||||
|
||||
To fix this, add angle brackets around the URL:
|
||||
|
||||
For more information, see <http://www.example.com/>.
|
||||
|
||||
Rationale: Without angle brackets, the URL isn't converted into a link in many
|
||||
markdown parsers.
|
||||
|
||||
Note: if you do want 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:
|
||||
|
||||
`http://www.example.com`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue