➕ Add mkdocs-htmlproofer-plugin to check for broken links #101
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This plugin validates URLs, including anchors, in rendered html files.
To check for broken links locally:
CHECK_BROKEN_LINKS=true mkdocs serve --quiet
See: https://github.com/manuzhang/mkdocs-htmlproofer-plugin
ebouchut
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR adds mkdocs-htmlproofer-plugin to help you find broken links.
Here is how to check for broken links in your local repository:
This command exits with an error if broken links are found.
ℹ️ We can always check a Web page for broken links using the W3C Link Checker. Sometimes, it may prove useful to dig deeper to determine the root cause of htmlproofer considering a link broken.