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:

```bash
pip install mkdocs-htmlproofer-plugin
```

Enable the plugin in your `mkdocs.yml`:

```yaml
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][http://www.mkdocs.org/user-guide/plugins/]

## Acknowledgement

This work is based on the [mkdocs-markdownextradata-plugin](https://github.com/rosscdh/mkdocs-markdownextradata-plugin) project and the [Finding and Fixing Website Link Rot with Python, BeautifulSoup and Requests](https://www.twilio.com/blog/2018/07/find-fix-website-link-rot-python-beautifulsoup-requests.html) article.



Project details


Release history Release notifications

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
mkdocs_htmlproofer_plugin-0.0.1-py3-none-any.whl (4.9 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page