Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-22 05:40:48 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Update documentation for MD034/no-bare-urls to recommend percent-encoding (closes #1212).

Browse source
This commit is contained in:
David Anson 2024-05-19 22:34:17 -07:00
parent 38cbbc9669
commit 90b572f292
3 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc-build/md034.md
View file

@ -11,6 +11,11 @@ To fix this, add angle brackets around the URL or email address:
For more info, visit <https://www.example.com/> or email <user@example.com>. For more info, visit <https://www.example.com/> or email <user@example.com>.
``` ```
If a URL or email address contains non-ASCII characters, it may be not be
handled as intended even when angle brackets are present. In such cases,
[percent-encoding](https://en.m.wikipedia.org/wiki/Percent-encoding) can be used
to comply with the required syntax for URL and email.
Note: To include a bare URL or email without it being converted into a link, Note: To include a bare URL or email without it being converted into a link,
wrap it in a code span: wrap it in a code span:

5
doc/Rules.md
View file

@ -1354,6 +1354,11 @@ To fix this, add angle brackets around the URL or email address:
For more info, visit <https://www.example.com/> or email <user@example.com>. For more info, visit <https://www.example.com/> or email <user@example.com>.
``` ```
If a URL or email address contains non-ASCII characters, it may be not be
handled as intended even when angle brackets are present. In such cases,
[percent-encoding](https://en.m.wikipedia.org/wiki/Percent-encoding) can be used
to comply with the required syntax for URL and email.
Note: To include a bare URL or email without it being converted into a link, Note: To include a bare URL or email without it being converted into a link,
wrap it in a code span: wrap it in a code span:

5
doc/md034.md
View file

@ -19,6 +19,11 @@ To fix this, add angle brackets around the URL or email address:
For more info, visit <https://www.example.com/> or email <user@example.com>. For more info, visit <https://www.example.com/> or email <user@example.com>.
``` ```
If a URL or email address contains non-ASCII characters, it may be not be
handled as intended even when angle brackets are present. In such cases,
[percent-encoding](https://en.m.wikipedia.org/wiki/Percent-encoding) can be used
to comply with the required syntax for URL and email.
Note: To include a bare URL or email without it being converted into a link, Note: To include a bare URL or email without it being converted into a link,
wrap it in a code span: wrap it in a code span: