Update tests and documentation for MD034/no-bare-urls to explain edge case behavior.

This commit is contained in:
David Anson 2023-02-06 21:09:58 -08:00
parent b990b3ea77
commit ddb71ed1e8
6 changed files with 106 additions and 3 deletions

View file

@ -76,3 +76,15 @@ Links with spaces inside angle brackets are okay: [blue jay](<https://en.wikiped
Email addresses are treated similarly: user@example.com {MD034}
Angle brackets work the same for email: <user@example.com>
---
[is-a-valid]: https://example.com
Links bind to the innermost [link that [is-a-valid] link](https://example.com) {MD034}
But not if the [link [is-not-a-valid] link](https://example.com) {MD034}
HOWEVER this scenario could have an invalid shortcut and IS reported
Escaping both inner square brackets avoids the unwanted report:
[link \[is-not-a-valid\] link](https://example.com)