mkdocs-htmlproofer-plugin 0.6.0

A MkDocs plugin that validates URL in rendered HTML files

mkdocs-htmlproofer-plugin

A MkDocs plugin that validates URLs, including anchors, in rendered html files.

Installation

0. Prerequisites

• Python >= 3.6
• MkDocs >= 0.17

1. Install the package with pip:

pip install mkdocs-htmlproofer-plugin

2. Enable the plugin in your mkdocs.yml:

plugins:
    - search
    - htmlproofer

Optionally, you may raise error and fail the build on bad url status.

plugins:
    - search
    - htmlproofer:
        raise_error: True

That can be switched off for combinations of urls ('*' means all urls) and status codes with raise_error_excludes.

plugins:
    - search
    - htmlproofer:
        raise_error: True
        raise_error_excludes: 
          504: ['https://www.mkdocs.org/']
          404: ['https://github.com/manuzhang/mkdocs-htmlproofer-plugin']
          400: ['*']

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.

To enable cross-page anchor validation, you must set use_directory_urls = False in mkdocs.yml:

use_directory_urls: False

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.