Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to ignore [example link](#) #3

Open
chris-dura opened this issue Sep 11, 2019 · 3 comments
Open

Add option to ignore [example link](#) #3

chris-dura opened this issue Sep 11, 2019 · 3 comments

Comments

@chris-dura
Copy 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 💀
@chris-dura
Copy link
Author

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 ![32px Camera Icon](./images/camera.svg =32x) camera icon.

And the output from check-md:

File is not found: ![32px Camera Icon](./images/camera.svg =32x) (/Users/CDura/code/my-project/foo/README.md:23:172)

@LucienZhang
Copy link

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"

@scbj
Copy link
Contributor

scbj commented Jul 1, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants