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

Add markdown link checker for docs #124

Merged
merged 2 commits into from
May 13, 2024
Merged

Add markdown link checker for docs #124

merged 2 commits into from
May 13, 2024

Conversation

dometto
Copy link
Member

@dometto dometto commented May 13, 2024

Resolves #59

This PR adds automatic link checking for links in the markdown files in this repo, which is especially relevant for the docs.

@dometto dometto force-pushed the add_doc_link_checker branch from e2d7ef2 to d49aee6 Compare May 13, 2024 12:19
@dometto dometto merged commit 05bff85 into main May 13, 2024
5 checks passed
@dometto dometto deleted the add_doc_link_checker branch May 13, 2024 12:27
@dometto
Copy link
Member Author

dometto commented May 13, 2024

@jelletreep @chStaiger Just FYI I've added an automatic link checker for our markdown files. It's pretty self-explanatory but just in case here is the documentation for the library it uses: https://github.com/tcort/markdown-link-check

And here for the github action: https://github.com/gaurav-nelson/github-action-markdown-link-check

(it supports ignoring certain files or links, for instance example URLs, like I've done here.)

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 this pull request may close these issues.

Add documentation linter
1 participant