Detect broken anchor links

[slorber]

🚀 Feature

We can detect broken links now, but another thing that can break easily is anchor links. As we currently auto-generate ids based on heading text, rewriting a heading can break linking, and it's not easy to notice it.

We need a way to check anchor links at build time too, fail fast, and report errors

[m-vdb]

That would be amazing! We were thinking about adding this to our documentation setup (I was initially looking into something like remark-validate-links).

[Zamiell]

If anyone else is desperately waiting on this feature, I was able to get broken link detection set up in CI for my Docusaurus website using remark-validate-links and a GitHub action.

• Here's my GitHub action YAML file (line 34-35 are the relevant lines)
• Here's my lint.sh file (very tiny, you could also skip this step by launching a NPM/yarn script in package.json from the GitHub action directly, but I wanted to keep it separate)
• Here's my remark config (line 16 is the relevant line, I also do a whole bunch of other checks)

[slorber]

Thanks @Zamiell that's useful to know how you made this work :)

We'll probably build something more "integrated" on top of the existing broken links checker (which only runs at built time), but having a remark linter could also be helpful to "pre-check" the links.

[IagoLast]

+1 for this feature,

Also slightly related (I can create a new ticket if you think it's adequate)

If your file is called docs index.md and the link points to docs Index.md it will work in OSX but it will fail in the linux CI 😕

I've tried to implement some workaround modifying this function and should not be very complicated. I think it would be great if docusaurus warned about this situation!

Thx for the nice work you do 🙏

[TysonMN]

I would also like this feature.

In the meantime, IntelliJ tells me if an open markdown file has Unresolved file references. Maybe there is a way for me to add that to my CI.