Unresolved link inside HTML comment

[KyrietS]

🐛 Bug Report

Prerequisites

• I'm using the latest version of Docusaurus.
• I have tried the npm run clear or yarn clear command.
• I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
• I have tried creating a repro with https://new.docusaurus.io
• I have read the console error message carefully (if applicable)

Description

I get an error when I build the website:

Docs markdown link couldn't be resolved: (somepage.md) in {path}/mypage.md for version current

mypage.md looks like this:

# title
<!-- [some page](somepage.md) -->

Have you read the Contributing Guidelines on issues?

Yes.

Steps to reproduce

Add to any markdown page:

<!-- [some text](nonexistentpage.md) -->

Expected behavior

Dummy links in HTML comments should not produce any warning / error during build.

Actual behavior

Docusaurus thinks that markdown link cannot be resolved even though it's inside the HTML comment. Error is printed and build fails.

Your environment

not relevant

Reproducible demo

https://stackblitz.com/edit/github-qhwl7g?file=docs/intro.md

[slorber]

Thanks

Yes, it seems our remark broken link checking logic does not account for HTML comments.

Problem in packages/docusaurus-utils/src/markdownLinks.ts

[MattiaPrimavera]

Hello everybody!

I'm new to the project.
I think indeed that stripping out html comments before analysing md links should fix this.

May I contribute by submitting a PR ?

[slorber]

Duplicate of #9048