feat(relative): add support for rewriting links in included files

examples/mkdocs/docs/index.md

@@ -0,0 +1,8 @@
+# Title
+
+This is a simple example of using MKdocs with mkdocs-include. 
+
+{!template/template.md!}
+
+
+{!template/template_2.md!}

examples/mkdocs/docs/template/template.md

@@ -0,0 +1 @@
+![some_image.jpg](some_image.jpg)

examples/mkdocs/docs/template/template_2.md

@@ -0,0 +1 @@
+![some_image.jpg](../images/image1.jpg)

examples/mkdocs/mkdocs.yml

@@ -0,0 +1,5 @@
+site_name: Example markdown-include
+
+markdown_extensions:
+  - markdown_include.include:
+      base_path: docs

markdown_include/include.py

@@ -30,6 +30,7 @@
 
 INC_SYNTAX = re.compile(r"{!\s*(.+?)\s*!((\blines\b)=([0-9 -]+))?\}")
 HEADING_SYNTAX = re.compile("^#+")
+LINK_SYNTAX = re.compile("(!|)\[[^]]+]\(([^)]+)\)")
 
 
 class MarkdownInclude(Extension):
@@ -99,8 +100,8 @@ def run(self, lines):
                 m = INC_SYNTAX.search(line)
 
                 while m:
-                    filename = m.group(1)
-                    filename = os.path.expanduser(filename)
+                    relative_filename = m.group(1)
+                    filename = os.path.expanduser(relative_filename)
                     if not os.path.isabs(filename):
                         filename = os.path.normpath(
                             os.path.join(self.base_path, filename)
@@ -170,6 +171,20 @@ def run(self, lines):
                                 text[i] = bonusHeading + text[i]
                             if self.headingOffset:
                                 text[i] = "#" * self.headingOffset + text[i]
+                        link = LINK_SYNTAX.search(text[i])
+                        if link:
+                            raw_path = link.group(2)
+                            if (
+                                not raw_path.startswith("http")
+                                and not raw_path.startswith("/")
+                                and not raw_path.startswith("#")
+                            ):
+                                path_ = f"{os.path.dirname(relative_filename)}{os.path.sep}{raw_path}"
+                                text[i] = (
+                                    text[i][: link.start(2)]
+                                    + path_
+                                    + text[i][link.end(2) :]
+                                )
 
                         text[i] = text[i].rstrip("\r\n")
                     text_to_insert = "\r\n".join(text)

tests/resources/docs/template/template.md

@@ -0,0 +1 @@
+![some_image.jpg](some_image.jpg)

tests/resources/docs/template/template_2.md

@@ -0,0 +1 @@
+![some_image.jpg](../images/image1.jpg)

tests/resources/docs/template/template_abs_link.md

@@ -0,0 +1 @@
+[some link](/template)

tests/resources/docs/template/template_frag_link.md

@@ -0,0 +1 @@
+[some link](#template)

tests/resources/with_img_link.md

@@ -0,0 +1 @@
+![some link](https://google.com)

tests/resources/with_link.md

@@ -0,0 +1 @@
+[some link](https://google.com)

tests/test_include.py

@@ -6,7 +6,6 @@
 
 import pytest
 
-
 RESOURCE_DIR = pathlib.Path(__file__).parent.absolute() / "resources"
 
 
@@ -22,6 +21,48 @@ def markdown_include_inherit_heading_depth():
     )
 
 
+def test_relative_path(markdown_include):
+    source = "{!docs/template/template.md!}"
+    html = markdown.markdown(source, extensions=[markdown_include])
+
+    assert html == "<p><img alt=\"some_image.jpg\" src=\"docs/template/some_image.jpg\" /></p>"
+
+
+def test_relative_path_parent(markdown_include):
+    source = "{!docs/template/template_2.md!}"
+    html = markdown.markdown(source, extensions=[markdown_include])
+
+    assert html == "<p><img alt=\"some_image.jpg\" src=\"docs/template/../images/image1.jpg\" /></p>"
+
+
+def test_relative_path_url_link(markdown_include):
+    source = "{!with_link.md!}"
+    html = markdown.markdown(source, extensions=[markdown_include])
+
+    assert html == "<p><a href=\"https://google.com\">some link</a></p>"
+
+
+def test_abs_url_link(markdown_include):
+    source = "{!docs/template/template_abs_link.md!}"
+    html = markdown.markdown(source, extensions=[markdown_include])
+
+    assert html == "<p><a href=\"/template\">some link</a></p>"
+
+
+def test_frag_url_link(markdown_include):
+    source = "{!docs/template/template_frag_link.md!}"
+    html = markdown.markdown(source, extensions=[markdown_include])
+
+    assert html == "<p><a href=\"#template\">some link</a></p>"
+
+
+def test_relative_path_img_url_link(markdown_include):
+    source = "{!with_img_link.md!}"
+    html = markdown.markdown(source, extensions=[markdown_include])
+
+    assert html == "<p><img alt=\"some link\" src=\"https://google.com\" /></p>"
+
+
 def test_single_include(markdown_include):
     source = "{!simple.md!}"
     html = markdown.markdown(source, extensions=[markdown_include])
@@ -34,7 +75,7 @@ def test_double_include(markdown_include):
     html = markdown.markdown(source, extensions=[markdown_include])
 
     assert (
-        html == "<p>This is a simple template and This is another simple template</p>"
+            html == "<p>This is a simple template and This is another simple template</p>"
     )
 
 
@@ -68,8 +109,8 @@ def test_embedded_template(markdown_include):
     html = markdown.markdown(source, extensions=[markdown_include])
 
     assert (
-        html
-        == "<p>This is a simple template</p>\n<p>This is a template with a template.</p>"
+            html
+            == "<p>This is a simple template</p>\n<p>This is a template with a template.</p>"
     )
 
 
@@ -89,7 +130,7 @@ def test_double_include_inherit_heading_depth(markdown_include_inherit_heading_d
     )
 
     assert (
-        html == "<p>This is a simple template and This is another simple template</p>"
+            html == "<p>This is a simple template and This is another simple template</p>"
     )