Adds htmlproofer plugin for mkdocs #70
Merged
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 is intended to catch bad anchors and broken external links. It does also significantly increase build time, though, because of all the checking. Because of that, two environment variables have been included in the `mkdocs.yml` file: ``` DOCS_ENABLE_HTMLPROOFER=True DOCS_FAIL_ON_BAD_LINK=False ``` This lets you easily change whether these are enabled, for testing and local builds.
|
Made this a branch+PR so people can give it a try locally before we try it and generate a bunch of errors in the builds for the website. |
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 is intended to catch bad anchors and broken external links.
It does also significantly increase build time, though, because of all the checking.
Because of that, two environment variables have been included in the
mkdocs.ymlfile:This lets you easily change whether these are enabled, for testing and local builds.
This idea taken from: https://xahteiwi.eu/blog/2023/02/23/mkdocs/