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

Links ignore using <https://> style links

Open nissessenap opened this issue 4 years ago • 2 comments

First of all thanks for this great tool. But I found a edge case in the fluxcd GOVERNANCE.md docs: https://github.com/fluxcd/community/issues/64

They are using, this style of links: <https://github.com/orgs/fluxcd/teams/maintainers>

Example:

Maintainers will be invited to the `@fluxcd/maintainers` <https://github.com/orgs/fluxcd/teams/maintainers> team, and are members of this team for as long as they are involved with the project.

And markdown-link-check dosen't notice it, I fully understand why that's the case but at the same time would it be hard to fix? Sadly I'm no node coder so I don't feel I will be able to create a good PR my self.

We can of course just change the linking style and the problem will be solved but at the same time it would be nice to be able to check those kind of links as well.

nissessenap avatar Jun 11 '21 21:06 nissessenap

Noting the broken link example above has since been fixed in https://github.com/fluxcd/community/pull/75/.

But yes I agree this checker should search for this link style as well, because it's a common style for displaying otherwise bare URLs. Thanks for opening this issue! 🙏

📝 Side note: the reason this link style may sometimes be used (<https://foo.bar> as opposed to [whatever](https://foo.bar)) is when the intent is to display a link to be read explicitly by the end user. Surrounding the URL by < and > is a recommended way to conform to this markdownlint rule MD034/no-bare-urls: Bare URL used.

scottrigby avatar Jul 02 '21 16:07 scottrigby

I think this would need to be supported in https://github.com/tcort/markdown-link-extractor

nschonni avatar Jul 02 '21 19:07 nschonni