Registry / testing / mkdocs-htmlproofer-plugin

mkdocs-htmlproofer-plugin

library1.5.0pypypiunverified

A MkDocs plugin that validates URLs in rendered HTML files after build. It checks internal links, anchors, and external URLs, reporting broken links. Version 1.5.0, active development.

testing

pip install mkdocs-htmlproofer-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · MKDOCS-HTMLPROOFER

mkdocs-htmlproofer-plugin

testingpythonv1.5.0

Install

3.8s avg

Import

—

Disk

37MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.5.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 37.5MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.8s · import 0.000s · 39MB

37MB installed

● package 37MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin

✓ # in mkdocs.yml: plugins: - htmlproofer

✗ import mkdocs_htmlproofer_plugin

This is a MkDocs plugin, not imported directly in Python code. Configure in mkdocs.yml.

Add the plugin to your mkdocs.yml and run mkdocs build. The plugin will validate all URLs in the output HTML.

# mkdocs.yml plugins: - htmlproofer # Build and check: # mkdocs build

Debug

Known issues

gotchaThe plugin validates URLs in the built HTML, not in the Markdown source. If you have relative links that resolve correctly at build time, they may appear broken if your site is served at a different path.

fix

Use absolute paths or set site_url in mkdocs.yml.

affects: all

deprecatedPython 3.8 and 3.9 are no longer supported as of v1.5.0.

fix

Upgrade to Python 3.10+.

affects: >=1.5.0

breakingAs of v1.5.0, external URL checks are now parallelized by default. This may cause increased network load or rate limiting.

fix

Set parallelization config options (e.g., max_concurrency) if needed.

affects: >=1.5.0

Upgrade

Version history

1.5.0latest on PyPI · released Feb 23, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/manuzhang/mkdocs-htmlproofer-plugin ↗

packagehttps://pypi.org/project/mkdocs-htmlproofer-plugin/ ↗