Skip to main content

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

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-htmlproofer-plugin, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_htmlproofer_plugin-0.0.3-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-htmlproofer-plugin-0.0.3.tar.gz (2.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page