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

Consider adding hyperlink dead-link checking to example site #161

Open
mhansen opened this issue Jan 30, 2022 · 0 comments · May be fixed by #198
Open

Consider adding hyperlink dead-link checking to example site #161

mhansen opened this issue Jan 30, 2022 · 0 comments · May be fixed by #198

Comments

@mhansen
Copy link
Contributor

mhansen commented Jan 30, 2022

Hi there, I just integrated https://github.com/untitaker/hyperlink, an intra-site link checker test that can run on CI, into Graphviz's Docsy site.

The checker is great, it immediately found 1000 dead links, it's very fast, and it doesn't use the network, so it's not flaky: see my testimonial: https://github.com/untitaker/hyperlink#testimonials.

I think perhaps this is worth baking into the Docsy platform by default -- perhaps starting by building the github action into the CI for docsy-example? Everyone struggles with dead links inside their websites, this is somewhere Docsy could add value with sensible defaults.

It was pretty straightforward to integrate on GitLab: https://gitlab.com/graphviz/graphviz.gitlab.io/-/blob/5dcfa637b7df17e3a1b821f3d7e9de8f5f82544b/.gitlab-ci.yml#L27 and it should be even easier on GitHub as there's a GitHub Action.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant