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.

Sign up for GitHub

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

Jump to bottom

Adds htmlproofer plugin for mkdocs #70

Merged
merged 1 commit into from
May 28, 2024
Merged

Adds htmlproofer plugin for mkdocs #70

merged 1 commit into from
May 28, 2024

Commits on May 20, 2024

  1. Adds htmlproofer plugin for mkdocs 

    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.
    @ikirker
    ikirker committed May 20, 2024
    Configuration menu
    Copy the full SHA
    c689673 View commit details
    Browse the repository at this point in the history