fix: finish implementation and unit tests

KyleKing · KyleKing · commit 19ff40369519 · 2025-08-18T06:25:52.000-06:00
diff --git a/mdformat_mkdocs/mdit_plugins/__init__.py b/mdformat_mkdocs/mdit_plugins/__init__.py
@@ -7,6 +7,7 @@
 )
 from ._material_deflist import (
     escape_deflist,
+    material_deflist_plugin,
     render_material_definition_body,
     render_material_definition_list,
     render_material_definition_term,
@@ -42,6 +43,7 @@
     "escape_deflist",
     "material_admon_plugin",
     "material_content_tabs_plugin",
+    "material_deflist_plugin",
     "mkdocstrings_autorefs_plugin",
     "mkdocstrings_crossreference_plugin",
     "pymd_abbreviations_plugin",
diff --git a/mdformat_mkdocs/mdit_plugins/_material_deflist.py b/mdformat_mkdocs/mdit_plugins/_material_deflist.py
@@ -28,8 +28,20 @@
 
 from __future__ import annotations
 
-from mdformat.renderer import RenderContext, RenderTreeNode
-from mdformat.renderer.typing import Render
+from typing import TYPE_CHECKING
+
+from markdown_it import MarkdownIt
+from mdit_py_plugins.deflist import deflist_plugin
+
+if TYPE_CHECKING:
+    from markdown_it import MarkdownIt
+    from mdformat.renderer import RenderContext, RenderTreeNode
+    from mdformat.renderer.typing import Render
+
+
+def material_deflist_plugin(md: MarkdownIt) -> None:
+    """Add mkdocs-material definition list support to markdown-it parser."""
+    md.use(deflist_plugin)
 
 
 def make_render_children(separator: str) -> Render:
@@ -44,14 +56,20 @@ def render_children(
     return render_children
 
 
-def render_material_definition_list() -> str:
+def render_material_definition_list(
+    node: RenderTreeNode,
+    context: RenderContext,
+) -> str:
     """Render Material Definition List."""
-    return make_render_children("\n")
+    return make_render_children("\n")(node, context)
 
 
-def render_material_definition_term() -> str:
+def render_material_definition_term(
+    node: RenderTreeNode,
+    context: RenderContext,
+) -> str:
     """Render Material Definition Term."""
-    return make_render_children("\n")
+    return make_render_children("\n")(node, context)
 
 
 def render_material_definition_body(
diff --git a/mdformat_mkdocs/plugin.py b/mdformat_mkdocs/plugin.py
@@ -7,7 +7,6 @@
 from typing import TYPE_CHECKING
 
 from mdformat.renderer import DEFAULT_RENDERERS, RenderContext, RenderTreeNode
-from mdit_py_plugins.deflist import deflist_plugin
 
 from ._helpers import ContextOptions, get_conf
 from ._normalize_list import normalize_list as unbounded_normalize_list
@@ -20,8 +19,10 @@
     PYMD_CAPTIONS_PREFIX,
     PYMD_SNIPPET_PREFIX,
     PYTHON_MARKDOWN_ATTR_LIST_PREFIX,
+    escape_deflist,
     material_admon_plugin,
     material_content_tabs_plugin,
+    material_deflist_plugin,
     mkdocstrings_autorefs_plugin,
     mkdocstrings_crossreference_plugin,
     pymd_abbreviations_plugin,
@@ -86,7 +87,7 @@ def update_mdit(mdit: MarkdownIt) -> None:
     mdit.use(material_admon_plugin)
     mdit.use(pymd_captions_plugin)
     mdit.use(material_content_tabs_plugin)
-    mdit.use(deflist_plugin)  # TODO: convert material_deflist to normal plugin
+    mdit.use(material_deflist_plugin)
     mdit.use(mkdocstrings_autorefs_plugin)
     mdit.use(pymd_abbreviations_plugin)
     mdit.use(pymd_admon_plugin)
diff --git a/tests/format/fixtures/material_deflist.md b/tests/format/fixtures/material_deflist.md
@@ -20,37 +20,36 @@ paragraph
 
 Term 1
 
-: Definition 1
+:   Definition 1
 
 Term 2 with *inline markup*
 
-: Definition 2
+:   Definition 2
 
-  ```
-  { some code, part of Definition 2 }
-  ```
+    ```
+    { some code, part of Definition 2 }
+    ```
 
-  Third paragraph of definition 2.
+    Third paragraph of definition 2.
 
 paragraph
 .
 
 Pandoc 2:
-
 .
 Term 1
 
-:   Definition
+: Definition
 with lazy continuation.
 
-    Second paragraph of the definition.
+  Second paragraph of the definition.
 .
 Term 1
 
-: Definition
-  with lazy continuation.
+:   Definition
+    with lazy continuation.
 
-  Second paragraph of the definition.
+    Second paragraph of the definition.
 .
 
 Pandoc 3
@@ -69,11 +68,11 @@ paragraph
 paragraph
 
 Term 1
-: Definition 1
+:   Definition 1
 
 Term 2
-: Definition 2a
-: Definition 2b
+:   Definition 2a
+:   Definition 2b
 
 paragraph
 .
@@ -87,12 +86,12 @@ Term 2
   :     code block
 .
 Term 1
-: paragraph
+:   paragraph
 
 Term 2
-: ```
-  code block
-  ```
+:   ```
+    code block
+    ```
 .
 
 List is tight, only if all dts are tight:
@@ -108,15 +107,15 @@ Term 2
 .
 Term 1
 
-: foo
+:   foo
 
-: bar
+:   bar
 
 Term 2
 
-: foo
+:   foo
 
-: bar
+:   bar
 .
 
 
@@ -132,13 +131,13 @@ Term 2
 .
 Term 1
 
-: foo
+:   foo
 
-  bar
+    bar
 
 Term 2
 
-: foo
+:   foo
 .
 
 Nested definition lists:
@@ -152,11 +151,11 @@ test
   : foo
 .
 test
-: foo
-  : bar
-    : baz
-  : bar
-: foo
+:   foo
+    :   bar
+        :   baz
+    :   bar
+:   foo
 .
 
 Regression test (blockquote inside deflist)
@@ -166,12 +165,11 @@ foo
 : baz
 .
 foo
-: > bar
-: baz
+:   > bar
+:   baz
 .
 
 Escaped deflist
-
 .
 Term 1
 \: Definition
diff --git a/tests/pre-commit-test.md b/tests/pre-commit-test.md
@@ -331,8 +331,6 @@ graph TD;
     C-->D;
 ```
 
-[external link]: https://github.com/czuli/github-markdown-example/tree/7326f19c94be992319394e5bfeaa07b30f858e46
-
 ______________________________________________________________________
 
 # Deflist Test
@@ -343,16 +341,18 @@ paragraph
 
 Term 1
 
-: Definition 1
+:   Definition 1
 
 Term 2 with *inline markup*
 
-: Definition 2
+:   Definition 2
 
-  ```
-  { some code, part of Definition 2 }
-  ```
+    ```
+    { some code, part of Definition 2 }
+    ```
 
-  Third paragraph of definition 2.
+    Third paragraph of definition 2.
 
 paragraph
+
+[external link]: https://github.com/czuli/github-markdown-example/tree/7326f19c94be992319394e5bfeaa07b30f858e46
diff --git a/tests/render/fixtures/material_deflist.md b/tests/render/fixtures/material_deflist.md
@@ -15,18 +15,18 @@ Example definition list <https://squidfunk.github.io/mkdocs-material/reference/l
     Nullam dignissim ultrices urna non auctor.
 .
 <dl>
-<dt>
-<code>Lorem ipsum dolor sit amet</code>
-</dt>
+<dt><code>Lorem ipsum dolor sit amet</code></dt>
 <dd>
-<p>Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus tellus non sem sollicitudin, quis rutrum leo facilisis.</p>
+<p>Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
+tellus non sem sollicitudin, quis rutrum leo facilisis.</p>
 </dd>
-<dt>
-<code>Cras arcu libero</code>
-</dt>
+<dt><code>Cras arcu libero</code></dt>
 <dd>
-<p>Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin ut eros sed sapien ullamcorper consequat. Nunc ligula ante.</p>
-<p>Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. Nam vulputate tincidunt fringilla. Nullam dignissim ultrices urna non auctor.</p>
+<p>Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
+ut eros sed sapien ullamcorper consequat. Nunc ligula ante.</p>
+<p>Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
+Nam vulputate tincidunt fringilla.
+Nullam dignissim ultrices urna non auctor.</p>
 </dd>
 </dl>
 .
diff --git a/tests/render/test_render.py b/tests/render/test_render.py
@@ -32,7 +32,7 @@ def with_plugin(filename, plugins):
             "material_content_tabs.md",
             [material_admon_plugin, material_content_tabs_plugin],
         ),
-        *with_plugin("mkdocs_deflist.md", [material_deflist_plugin]),
+        *with_plugin("material_deflist.md", [material_deflist_plugin]),
         *with_plugin("mkdocstrings_autorefs.md", [mkdocstrings_autorefs_plugin]),
         *with_plugin("pymd_abbreviations.md", [pymd_abbreviations_plugin]),
         *with_plugin("pymd_captions.md", [pymd_captions_plugin]),
