Add mkdocs-htmlproofer-plugin

Author: manuzhang

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contribution Guidelines
+
+Thank you for considering to contribute to this project. These guidelines will help you get going with development and outline the most important rules to follow when submitting pull requests for this project.
+
+<br/>
+
+## Development
+
+#### Setup
+
+##### Prerequisites
+
+- [Python 3]
+- [virtualenv]
+
+##### Steps
+
+1. Clone the (forked) repository
+1. Create a virtualenv with `virtualenv env`
+1. Activate virtualenv `source env/bin/activate` or `env/Scripts/activate` on Windows
+1. Run `pip install -r requirements.txt` in the project directory
+
+#### Running Tests
+
+```bash
+pytest
+```
+
+<br/>
+
+
+## Submitting Changes
+
+To get changes merged, create a pull request. Here are a few things to pay attention to when doing so: 
+
+#### Commit Messages
+
+The summary of a commit should be concise and worded in an imperative mood.  
+...a *what* mood? This should clear things up: *[How to Write a Git Commit Message][git-commit-message]*
+
+#### Code Style
+
+Make sure your code follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) and keeps things consistent with the rest of the code. 
+
+#### Tests
+
+If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.
+
+[Python 3]: https://www.python.org/
+[virtualenv]: https://virtualenv.pypa.io/
+[git-commit-message]: https://chris.beams.io/posts/git-commit/

LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2018 Lukas Geiter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,28 @@
+# mkdocs-htmlproofer-plugin
+
+*A MkDocs plugin that checks URL*
+
+
+
+## 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][mkdocs-plugins]
+

htmlproofer/__init__.py

@@ -0,0 +1,27 @@
+from mkdocs.plugins import BasePlugin
+
+from bs4 import BeautifulSoup
+import urllib.request
+
+
+class HtmlProoferPlugin(BasePlugin):
+
+    def on_post_page(self, output_content, config, **kwargs):
+        soup = BeautifulSoup(output_content, 'html.parser')
+        local = ['localhost', '127.0.0.1']
+        for a in soup.find_all('a', href=True):
+            url = a['href']
+            for local in ('localhost', '127.0.0.1', 'app_server'):
+                if url.startswith('http://' + local):
+                    return
+            if url.startswith('http'):
+                print('Checking url ' + url)
+                try:
+                    status = urllib.request.urlopen(url, timeout=10).getcode()
+                    if status != 200:
+                        print('Bad url ' + url)
+                except:
+                    print('Failed to open url ' + url)
+
+
+

htmlproofer/plugin.py

@@ -0,0 +1,40 @@
+import os
+from setuptools import setup, find_packages
+
+
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+
+setup(
+    name='mkdocs-htmlproofer-plugin',
+    version='0.0.1',
+    description='A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template',
+    long_description=read('README.md'),
+    keywords='mkdocs python markdown extra values',
+    url='https://github.com/manuzhang/mkdocs-htmlproofer-plugin',
+    author='Manu Zhang',
+    author_email='[email protected]',
+    license='MIT',
+    python_requires='>=3.5',
+    install_requires=[
+        'mkdocs>=0.17'
+    ],
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7'
+    ],
+    packages=find_packages(exclude=['*.tests']),
+    entry_points={
+        'mkdocs.plugins': [
+            'htmlproofer = htmlproofer.plugin:HtmlProoferPlugin'
+        ]
+    }
+)