Add checklinks tox env and shell script. #955
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is using the Node.js tool from tcort/markdown-link-check which runs on Markdown input.
Note that there are currently quite a few broken links in the documentation. We need to be checking these regularly. I'll be fixing them as I continue to work on this PR.
I should also note that this tool will properly verify MkDocs' internal links if they are proper relative links, but will error on internal absolute links. This fits MkDocs' requirements and ensures absolute links don't slip in. This provides an added benefit we might miss if we were using an HTML based tool on the built site.
If only the tool reported the line numbers where the links were defined (see tcort/markdown-link-check#93).