search

DavidAnson / markdownlint

A Node.js style checker and lint tool for Markdown/CommonMark files.
MIT License
4.83k stars 732 forks source link

Disable link checking for GitHub Alerts #1418

Open gabeseltzer opened 2 days ago

gabeseltzer commented 2 days ago

GitHub uses the following syntax for "Alerts":

> [!NOTE]
> Useful information that users should know, even when skimming content.

markdownlint will flag the [!NOTE] as a link, and will tell you No link definition found: '!NOTE'(link.no-such-reference). Can we turn this off for the keywords that make up alerts? Specifically:

DavidAnson commented 2 days ago

The error error message you show above is not coming from this tool. You can see that your example produces no violations: https://dlaa.me/markdownlint/#%25m%23%20Issue%201418%0A%0A%3E%20%5B!NOTE%5D%0A%3E%20Useful%20information%0A

It looks like the message you show is coming from VS Code instead: https://stackoverflow.com/questions/75252767/have-vscode-ignore-specific-reference-links-in-markdown-validation