Ribasim icon indicating copy to clipboard operation
Ribasim copied to clipboard

Test for dead links in Quarto documentation

Open evetion opened this issue 1 year ago • 2 comments

I wish Quarto render would error by default, also for external links, but last I checked I didn't see a way to enable that.

But yes, we should look into external tooling for this, feel free to make an issue.

Originally posted by @visr in https://github.com/Deltares/Ribasim/issues/1842#issuecomment-2368687159

Ideally it would work on pre-commit.

evetion avatar Sep 23 '24 16:09 evetion

This one has github a action: https://github.com/lycheeverse/lychee/

Huite avatar Sep 23 '24 18:09 Huite

I tried lychee in c46b0e9d0be510c2949a39fdfcce23a3d137030a but that wasn't working yet. I think it would work better as part of the doc render pipeline. When the quarto docs are done, run lychee on the HTML file before publishing. At that stage the internal Quarto links like in #1842 should also be checkable. In my commit I didn't get it to trigger on broken links in QMD files.

visr avatar Sep 24 '24 14:09 visr