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.
*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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-htmlproofer-plugin-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fa5ec0ec5b5f92f297e42b429ba87078507e05ac6fb378680dd251aa2fa14dc |
|
MD5 | 67c8bbbd56d5933dd5c2516113022d74 |
|
BLAKE2b-256 | b914bae255bbef30c167c4b3d121989e5e3fd731711c979c48f414ccb8a86a8b |
Close
Hashes for mkdocs_htmlproofer_plugin-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd2633188b9ab89473fa762adc73abfc6860763afcb4d6198d3a25b0826dad75 |
|
MD5 | d6a84f686291e995a3be6ae007a9ae24 |
|
BLAKE2b-256 | a27dec79d9161a98b39e5736f4942f2d0a757115770ed1e80cd9b8ba8635a37b |