{"id":24042,"library":"mkdocs-htmlproofer-plugin","title":"MkDocs HTMLProofer Plugin","description":"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.","status":"active","version":"1.5.0","language":"python","source_language":"en","source_url":"https://github.com/manuzhang/mkdocs-htmlproofer-plugin","tags":["mkdocs","plugin","htmlproofer","url-validation"],"install":[{"cmd":"pip install mkdocs-htmlproofer-plugin","lang":"bash","label":"pip install"}],"dependencies":[],"imports":[{"note":"This is a MkDocs plugin, not imported directly in Python code. Configure in mkdocs.yml.","wrong":"import mkdocs_htmlproofer_plugin","symbol":"plugin","correct":"# in mkdocs.yml:\nplugins:\n  - htmlproofer"}],"quickstart":{"code":"# mkdocs.yml\nplugins:\n  - htmlproofer\n\n# Build and check:\n# mkdocs build","lang":"yaml","description":"Add the plugin to your mkdocs.yml and run mkdocs build. The plugin will validate all URLs in the output HTML."},"warnings":[{"fix":"Use absolute paths or set site_url in mkdocs.yml.","message":"The 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.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade to Python 3.10+.","message":"Python 3.8 and 3.9 are no longer supported as of v1.5.0.","severity":"deprecated","affected_versions":">=1.5.0"},{"fix":"Set parallelization config options (e.g., max_concurrency) if needed.","message":"As of v1.5.0, external URL checks are now parallelized by default. This may cause increased network load or rate limiting.","severity":"breaking","affected_versions":">=1.5.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install mkdocs-htmlproofer-plugin'.","cause":"Plugin not installed in the Python environment.","error":"Error: The 'htmlproofer' plugin is not installed"},{"fix":"Ensure the plugin name is exactly 'htmlproofer' in mkdocs.yml.","cause":"Typo in plugin name or incorrect configuration.","error":"ERROR   -  Config value 'plugins': Invalid plugin 'htmlproofer'"},{"fix":"Check internet connectivity or add the URL to 'ignore_urls' in config.","cause":"External URL check fails due to network issues or invalid domain.","error":"urllib.error.URLError: <urlopen error [Errno -2] Name or service not known>"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}