Add Jx embedding support

Author: jpsca

src/writeadoc/md/custom_html.py src/writeadoc/md/mdjx.pysrc/writeadoc/md/custom_html.py renamed to src/writeadoc/md/mdjx.py

@@ -1,36 +1,34 @@
-"""Plugin to treat uppercase HTML tags as block-level raw HTML.
+"""Plugin to treat uppercase HTML tags as block-level raw HTML, later
+to be rendered by Jx (if imports are set up).
 
 This allows custom component tags like <Card>, <Test>, <Header> to be
 treated as block HTML when they appear on their own (with blank lines
 around them), preventing markdown processing inside them.
 """
 import re
+import typing as t
 
 from mistune import BlockParser, BlockState
 from mistune.markdown import Markdown
 
 
-def parse_custom_html(
-    block: BlockParser, m: re.Match[str], state: BlockState
-) -> int:
+if t.TYPE_CHECKING:
+    from mistune.core import BaseRenderer
+
+
+def parse_mdjx(block: BlockParser, m: re.Match[str], state: BlockState) -> int:
     """Parse uppercase HTML tags as block HTML."""
     text = m.group(0)
     end_pos = m.end() + 1  # Position after trailing newline
+    state.append_token({"type": "mdjx", "raw": text})
+    return end_pos
 
-    # Check if another uppercase tag follows immediately (no blank line).
-    # If so, don't add newline to raw (renderer will add one anyway).
-    remaining = state.src[end_pos:]
-    if re.match(r"[ ]{0,3}<[A-Z]", remaining):
-        # Another uppercase tag follows - don't add extra newline
-        state.append_token({"type": "block_html", "raw": text})
-    else:
-        # Followed by blank line or other content - add newline for proper spacing
-        state.append_token({"type": "block_html", "raw": text + "\n"})
 
-    return end_pos
+def render_mdjx(renderer: "BaseRenderer", raw: str) -> str:
+    return raw + "\n"
 
 
-def custom_block_html(md: Markdown) -> None:
+def mdjx(md: Markdown) -> None:
     """Register the custom block HTML rule.
 
     This rule matches HTML tags that start with an uppercase letter
@@ -40,15 +38,26 @@ def custom_block_html(md: Markdown) -> None:
     The content inside these tags is NOT processed as markdown.
     """
     # Pattern to match uppercase tags as block HTML
+    # Supports both self-closing tags (<Tag />) and paired tags (<Tag>...</Tag>)
     # - ^[ ]{0,3} - start of line with up to 3 spaces (standard block indent)
+    # Self-closing branch:
+    # - <[A-Z][a-zA-Z0-9]* - opening tag starting with uppercase
+    # - [^>]* - optional attributes (anything except >)
+    # - /> - self-closing end
+    # Paired tag branch:
     # - <(?P<_customtag>[A-Z][a-zA-Z0-9]*) - opening tag starting with uppercase
     # - (?:\s[^>]*)? - optional attributes
     # - > - close of opening tag
     # - [\s\S]*? - content (lazy match, including newlines)
     # - </(?P=_customtag)> - matching closing tag (backreference)
     # - [ \t]*$ - optional trailing whitespace, end of line
     pattern = (
-        r"^[ ]{0,3}<(?P<_customtag>[A-Z][a-zA-Z0-9]*)(?:\s[^>]*)?>"
-        r"[\s\S]*?</(?P=_customtag)>[ \t]*$"
+        r"^[ ]{0,3}(?:"
+        r"<[A-Z][a-zA-Z0-9]*[^>]*/>"  # Self-closing tag
+        r"|"
+        r"<(?P<_customtag>[A-Z][a-zA-Z0-9]*)(?:\s[^>]*)?>[\s\S]*?</(?P=_customtag)>"  # Paired tags
+        r")[ \t]*$"
     )
-    md.block.register("custom_html", pattern, parse_custom_html, before="raw_html")
+    md.block.register("mdjx", pattern, parse_mdjx, before="raw_html")
+    if md.renderer and md.renderer.NAME == "html":
+        md.renderer.register("mdjx", render_mdjx)

src/writeadoc/md/render.py

@@ -15,11 +15,11 @@
 from .admonition import Admonition
 from .attrs import block_attrs, inline_attrs
 from .block_directive import BlockDirective
-from .custom_html import custom_block_html
 from .div import Container
 from .figure import Figure
 from .formatting import insert, mark, strikethrough, subscript, superscript
 from .html_renderer import HTMLRenderer
+from .mdjx import mdjx
 from .tab import Tab
 
 
@@ -32,7 +32,7 @@
         table,
         task_lists,
         #
-        custom_block_html,
+        mdjx,
         block_attrs,
         inline_attrs,
         insert,

tests/md/test_html.py

@@ -50,7 +50,6 @@ def test_block_html_like():
 """
     expected = """<p>lorem</p>
 <Test>Hello **World**</Test>
-
 <p>ipsum</p>
 """
     result = render_markdown(source, __file__=__file__)[0]
@@ -67,7 +66,6 @@ def test_block_tag_with_attrs():
 """
     expected = """<p>lorem</p>
 <Card class="hi">This **is** a test</Card>
-
 <p>ipsum</p>
 """
     result = render_markdown(source, __file__=__file__)[0]
@@ -86,7 +84,6 @@ def test_block_html_like_group():
     expected = """<p>lorem</p>
 <Lorem>Hello World</Lorem>
 <Ipsum>Hello World</Ipsum>
-
 <p>ipsum</p>
 """
     result = render_markdown(source, __file__=__file__)[0]
@@ -107,7 +104,6 @@ def test_block_html_like_nested():
 <Card>
 <Header>Hello World</Header>
 </Card>
-
 <p>ipsum</p>
 """
     result = render_markdown(source, __file__=__file__)[0]
@@ -128,7 +124,24 @@ def test_block_html_like_nested_with_spaces():
 <Card>
   <Header>Hello World</Header>
 </Card>
+<p>ipsum</p>
+"""
+    result = render_markdown(source, __file__=__file__)[0]
+    print(result)
+    assert result == expected
+
+
+def test_self_closing_blocks():
+    source = """lorem
 
+<Test class="test" />
+<Test class="test"/>
+
+ipsum
+"""
+    expected = """<p>lorem</p>
+<Test class="test" />
+<Test class="test"/>
 <p>ipsum</p>
 """
     result = render_markdown(source, __file__=__file__)[0]