NixOS / nix

Nix, the purely functional package manager
https://nixos.org/
GNU Lesser General Public License v2.1
12.13k stars 1.47k forks source link

Check link anchors in mdbook docs? #7691

Open roberth opened 1 year ago

roberth commented 1 year ago

Is your feature request related to a problem? Please describe.

mdBook isn't capable of checking the anchors that are linked to (bla.html#foo -> anchor: foo) An extra tool could do this for us.

Describe the solution you'd like

I've solved this with linkchecker

We could do the same and make it a separate check so that the nix package does not need another dependency.

Describe alternatives you've considered

Review carefully and wait for users to hopefully report the things we missed; busywork for everyone.

Additional context

Priorities

Add :+1: to issues you find important.

edolstra commented 1 year ago

Wouldn't this require network access?

roberth commented 1 year ago

It defaults to checking internal links only.

I could also add a networked check with Hercules CI if you like. It can be synchronous on each push, merge, daily, or a combination.