check-md
check-md copied to clipboard
Add option to ignore [example link](#)
There's some legit reasons that you may want to have a link that actually doesn't go anywhere in the markdown, like [example link text](#)
, especially in documentation sites.
In fact, you may want to be able to ignore any particular pattern
in the link URL (not just ignore a particular filename pattern). For example:
Here's a [internal link](https://auth.my-project.com) that is behind Oauth, so it'll always look ☠️, but it's not 💀
Or, another use case for ignoring (or removing) a certain RegEx
pattern from the link URL. The markdown-it-imsize
plugin requires additional syntax in the image link.
Here is a  camera icon.
And the output from check-md
:
File is not found:  (/Users/CDura/code/my-project/foo/README.md:23:172)
Another case for ignoring certain pattern is for footnote syntax. check here
Here is a footnote reference[^1].
[^1]: Here is the footnote. <-- this will raise an error of "File is not found"
Another case for ignoring certain pattern is for footnote syntax. check here
Here is a footnote reference[^1]. [^1]: Here is the footnote. <-- this will raise an error of "File is not found"
This feature for footnotes has been resolved in #8