Skip image in anchor tag

Author: blueswen

mkdocs_glightbox/plugin.py

@@ -93,7 +93,7 @@ def on_post_page(self, output, page, config, **kwargs):
         return str(soup)
 
     def on_page_content(self, html, page, config, **kwargs):
-        """Wrap img tag with archive tag with glightbox class and attributes from config"""
+        """Wrap img tag with anchor tag with glightbox class and attributes from config"""
         # skip page with meta glightbox is false
         if "glightbox" in page.meta and page.meta.get("glightbox", True) is False:
             return html
@@ -105,7 +105,7 @@ def on_page_content(self, html, page, config, **kwargs):
         soup = BeautifulSoup(html, "html.parser")
         imgs = soup.find_all("img")
         for img in imgs:
-            if set(skip_class) & set(img.get("class", [])):
+            if set(skip_class) & set(img.get("class", [])) or img.parent.name == "a":
                 continue
             a = soup.new_tag("a")
             a["class"] = "glightbox"

tests/fixtures/docs/image_in_anchor.md

@@ -0,0 +1 @@
+[![image](img.png)](https://blueswen.github.io/mkdocs-glightbox/)

tests/test_builds.py

@@ -557,3 +557,19 @@ def test_static(tmp_path):
         os.path.join(testproject_path, "site/assets/javascripts/glightbox.min.js")
     )
 
+
+def test_image_in_anchor(tmp_path):
+    """
+    Disable when image in an anchor tag
+    """
+    mkdocs_file = "mkdocs.yml"
+    testproject_path = validate_mkdocs_file(tmp_path, f"tests/fixtures/{mkdocs_file}")
+    file = testproject_path / "site/image_in_anchor/index.html"
+    contents = file.read_text(encoding="utf8")
+    path = "../"
+    validate_static(contents, path)
+    validate_script(contents)
+    assert re.search(
+        rf'<a class="glightbox" .* href="{path}img.png"><img .* src="{path}img.png"\/><\/a>',
+        contents,
+    ) is None