Metadata-Version: 2.1
Name: mkdocs-htmlproofer-plugin
Version: 0.0.3
Summary: A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template
Home-page: https://github.com/manuzhang/mkdocs-htmlproofer-plugin
Author: Manu Zhang
Author-email: owenzhang1990@gmail.com
License: MIT
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. 
        
        
Keywords: mkdocs python markdown extra values
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.5
Description-Content-Type: text/markdown
