markdown-link-check icon indicating copy to clipboard operation
markdown-link-check copied to clipboard

Broken by footnote

Open d-tsuji opened this issue 3 years ago • 2 comments

What happened?

Footnotes are inspected by markdown-link-check and fail.

sample

  • Sample.md
# sample 

This is sample footnote[^1].

[^1]: foot

Result

$ markdown-link-check Sample.md

FILE: README.md
[✖] foot

1 links checked.

ERROR: 1 dead links found!
[✖] foot → Status: 400

background

GitHub and others support footnotes. Yes, footnotes are links, but they are also checked by markdown-link-check.

https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/

Expected

Is there any way to ignore footnotes?

Option of ignorePatterns checks for link destination strings. Therefore, the following settings will not work.

{
    "ignorePatterns": [
        {"pattern":"^\^"}
    ]
}

This is because footnote links usually do not contain specific strings, such as http.

d-tsuji avatar Sep 20 '22 23:09 d-tsuji

Similarly, reference-style links are also broken:

[Foo][foo]

[foo]: https://example.com

danielhoherd avatar Mar 12 '25 15:03 danielhoherd

This issue has been marked as stale because it has been open 60 days with no activity. It will be closed in 30 days unless the stale label is removed or someone adds a comment.

github-actions[bot] avatar May 14 '25 08:05 github-actions[bot]

This issue was closed because it has been marked as stale for 30 days with no activity.

github-actions[bot] avatar Jun 13 '25 08:06 github-actions[bot]