mkdocs-htmlproofer-plugin 0.0.3

A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template

mkdocs-htmlproofer-plugin

A MkDocs plugin that validates URL in rendered html files

Installation

Note: This package requires MkDocs version 0.17 or higher.

Install the package with pip:

pip install mkdocs-htmlproofer-plugin

Enable the plugin in your mkdocs.yml:

plugins:
    - search
    - htmlproofer

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

More information about plugins in the MkDocs documentation

Acknowledgement

This work is based on the mkdocs-markdownextradata-plugin project and the Finding and Fixing Website Link Rot with Python, BeautifulSoup and Requests article.