Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test for dead links in Quarto documentation #1844

Open
evetion opened this issue Sep 23, 2024 · 2 comments
Open

Test for dead links in Quarto documentation #1844

evetion opened this issue Sep 23, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation improvement Improvements of the usability of existing functionality

Comments

@evetion
Copy link
Member

evetion commented Sep 23, 2024

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 #1842 (comment)

Ideally it would work on pre-commit.

@Huite
Copy link
Contributor

Huite commented Sep 23, 2024

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

@visr visr self-assigned this Sep 23, 2024
@visr visr added documentation Improvements or additions to documentation improvement Improvements of the usability of existing functionality labels Sep 24, 2024
@visr visr removed their assignment Sep 24, 2024
@visr
Copy link
Member

visr commented Sep 24, 2024

I tried lychee in c46b0e9 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation improvement Improvements of the usability of existing functionality
Projects
Status: To do
Development

No branches or pull requests

3 participants