Create mkdocs webcontext plugin

Author: Darrelk

.gitignore

@@ -0,0 +1,7 @@
+venv
+build
+dist
+.idea
+.vscode
+build.bat
+/.vs

MANIFEST.in

@@ -0,0 +1 @@
+include readme.md

mkdocs_webcontext_plugin/__init__.py

@@ -0,0 +1 @@
+from .plugin import Webcontext

mkdocs_webcontext_plugin/plugin.py

@@ -0,0 +1,64 @@
+import os
+import sys
+import re
+import logging
+from timeit import default_timer as timer
+from datetime import datetime, timedelta
+
+from mkdocs import utils as mkdocs_utils
+from mkdocs.config import config_options, Config
+from mkdocs.plugins import BasePlugin
+from mkdocs.structure.pages import Page
+
+from pathlib import Path
+
+LOGGER = logging.getLogger(__name__)
+
+class Webcontext(BasePlugin):
+
+    config_scheme = (
+        ('context', config_options.Type(str, default='/')),
+    )
+
+    md_link = re.compile(r'''(\[[^]]*]\()(/[^)]*)(\))|(\[[^]]*]:\s)(/[^\n\r)]*)''', re.DOTALL | re.UNICODE)      
+
+    def __init__(self):
+        self.enabled = True
+        self.total_time = 0
+    
+    def on_page_markdown(self, markdown, page, config, files):
+        context = self.config['context']
+        new_md = self._absolute_to_webcontext(markdown, context)
+        return new_md
+    
+    def _absolute_to_webcontext(self, markdown, context: str):
+        LOGGER.debug('webcontext: using defined context = %s', context)
+
+        def _check_link(link: str, context: str):
+            contextLink = context +"/"+ link[1:]
+            LOGGER.debug('webcontext: replace %s with %s', link, contextLink)
+            link = link.replace(link[1:], contextLink)
+            link = link.replace("\\", "/")
+
+            return link
+
+        def _to_webcontext(context:str):
+            def re_write_link(matchobj):
+                group1 = matchobj.group(1)  # front stuff
+                group2 = matchobj.group(2)  # the actual link
+                group3 = matchobj.group(3)  # closing tag
+
+                if group1 and group2 and group3:
+                    link = _check_link(group2, context)
+                    return "{}{}{}".format(group1, link, group3)
+
+                group4 = matchobj.group(4)  # front stuff
+                group5 = matchobj.group(5)  # the actual link
+                if group4 and group5:
+                    link = _check_link(group5, context)
+                    return "{}{}".format(group4, link)
+
+            return re_write_link
+
+        file_data = re.sub(self.md_link, _to_webcontext(context), markdown)
+        return file_data

readme.md

@@ -0,0 +1,32 @@
+# Webcontext link converter plugin for mkdocs
+
+MkDocs allows absulute paths assuming that the site is deployed to the root of the hosted website like "http://localhost/". When using the following absolute path "/assets/image1.jpg" it is actually using "http://localhost/assets/image1.jpg" which is correct if the MkDocs is deployed to the site root.
+
+When the server root is not the same as the MkDocs root, the webcontext plugin can be used to define a webcontext to use instead of the defined root. The webcontext path which can be anyting like "/projectname/documents" is used where "/" is defined.
+
+Some examples of site urls before and after using the webcontext plugin:
+Site Url | Context  | Image before | Image after 
+---------|----------|--------------|------------ 
+http://example.com/        | / | /images/img1.jpg | /images/img1.jpg
+http://example.com/foo     | /foo | /images/img1.jpg | /foo/images/img1.jpg
+http://example.com/foo/bar | /foo/bar | /images/img1.jpg | /foo/bar/images/img1.jpg
+http://127.0.0.1:8000      | / | /images/img1.jpg | /images/img1.jpg
+http://127.0.0.1:8000/foo  | /foo | /images/img1.jpg | /foo/images/img1.jpg
+
+
+## Quick start
+
+1. Install the module using pip: `pip install mkdocs-webcontext`
+
+2. In your project, add a plugin configuration to `mkdocs.yml`:
+
+   ```yaml
+   plugins:
+     - webcontext:
+         context: foo/bar
+   ```
+
+Special thanks to the following repositories for guidance:
+
+* [byrnereese/mkdocs-plugin-template](https://github.com/byrnereese/mkdocs-plugin-template)
+* [sander76/mkdocs-abs-rel-plugin](https://github.com/sander76/mkdocs-abs-rel-plugin)

setup.py

@@ -0,0 +1,22 @@
+import sys
+from shutil import rmtree
+from pathlib import Path
+from setuptools import setup, Command
+
+setup(
+    name="mkdocs-webcontext-plugin",
+    version="0.1.0",
+    packages=["mkdocs_webcontext_plugin"],
+    url="https://github.com/darrelk/mkdocs-webcontext-plugin",
+    license="MIT",
+    author="darrelk",
+    author_email="darrelkley@gmail.com",
+    description="Mkdocs plugin to convert absolute paths to Webcontext aware paths.",
+    long_description=README,
+    long_description_content_type="text/markdown",
+    entry_points={
+        "mkdocs.plugins": [
+            "webcontext = mkdocs_webcontext_plugin:Webcontext"
+        ]
+    }
+)