termrender 3.0.2__tar.gz → 4.0.0__tar.gz

{termrender-3.0.2 → termrender-4.0.0}/CHANGELOG.md

@@ -1,6 +1,31 @@
 # CHANGELOG
 
 
+## v4.0.0 (2026-07-06)
+
+### Features
+
+- **mermaid**: Also route ```mermaid fences through the mermaid renderer
+  ([`99a8017`](https://github.com/crouton-labs/termrender/commit/99a801783d719125505eef2dc1194e2e418ed025))
+
+BREAKING CHANGE: partially reverses 083f590. A fenced code block whose info string is `mermaid`
+  (e.g. GFM ````mermaid```` fences used by GitHub and most docs/agents unaware of the :::mermaid
+  directive) now renders as an ASCII mermaid diagram, same as :::mermaid. Any other language tag
+  still falls through to a plain CODE block; the :::mermaid directive is unchanged.
+
+Root-caused: the reported bug (fences render as raw source, not a diagram) was not a regression or
+  missing binary — the vendored mermaid-ascii binary and subprocess pipeline both work correctly. It
+  was 083f590's deliberate, documented breaking change dropping fence support. Human chose to extend
+  support back to fences rather than close as working-as-intended.
+
+### Breaking Changes
+
+- **mermaid**: Partially reverses 083f590. A fenced code block whose info string is `mermaid` (e.g.
+  GFM ````mermaid```` fences used by GitHub and most docs/agents unaware of the :::mermaid
+  directive) now renders as an ASCII mermaid diagram, same as :::mermaid. Any other language tag
+  still falls through to a plain CODE block; the :::mermaid directive is unchanged.
+
+
 ## v3.0.2 (2026-06-17)
 
 ### Bug Fixes

{termrender-3.0.2 → termrender-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: termrender
-Version: 3.0.2
+Version: 4.0.0
 Summary: Rich terminal rendering of directive-flavored markdown
 Project-URL: Homepage, https://github.com/CaptainCrouton89/termrender
 Project-URL: Repository, https://github.com/CaptainCrouton89/termrender
@@ -408,7 +408,7 @@ Horizontal rules with optional centered labels.
 
 ### Mermaid diagrams
 
-Renders mermaid flowcharts as ASCII art via [mermaid-ascii](https://github.com/mermaid-js/mermaid-ascii). Mermaid uses the `:::mermaid` directive — backtick fences (`` ```mermaid ``) are treated as plain code blocks.
+Renders mermaid flowcharts as ASCII art via [mermaid-ascii](https://github.com/mermaid-js/mermaid-ascii). Use the `:::mermaid` directive, or a standard GFM ` ```mermaid ` fenced code block — both render the same diagram.
 
 **Input:**
 ```markdown

{termrender-3.0.2 → termrender-4.0.0}/README.md

@@ -380,7 +380,7 @@ Horizontal rules with optional centered labels.
 
 ### Mermaid diagrams
 
-Renders mermaid flowcharts as ASCII art via [mermaid-ascii](https://github.com/mermaid-js/mermaid-ascii). Mermaid uses the `:::mermaid` directive — backtick fences (`` ```mermaid ``) are treated as plain code blocks.
+Renders mermaid flowcharts as ASCII art via [mermaid-ascii](https://github.com/mermaid-js/mermaid-ascii). Use the `:::mermaid` directive, or a standard GFM ` ```mermaid ` fenced code block — both render the same diagram.
 
 **Input:**
 ```markdown

{termrender-3.0.2 → termrender-4.0.0}/src/termrender/CLAUDE.md

@@ -1,2 +1,3 @@
 - **Nesting is by colon count** (`parser.py`, since `4a501d9`): an outer directive must use strictly MORE colons than the directive nested inside it — `::::columns` (4) wraps `:::col` (3); a leaf closes with a bare run of its own colon count. Equal-colon nesting is a `syntax_error` (the closer matches the wrong opener). Mirrors MyST colon fences. All docs/examples must follow this — `termrender doc check` is the gate.
 - **QUOTE** height gets `+1` only when `author` or `by` attr is set. Using any other key (`attribution`, `source`) silently omits the extra line — the renderer's attribution line is clipped.
+- **``` mermaid fences and `:::mermaid` both produce `BlockType.MERMAID`** (`parser.py::_convert_ast`, block_code handling): a fenced code block whose info string's first word is `mermaid` (case-insensitive) is special-cased to `BlockType.MERMAID` instead of `BlockType.CODE`, so GFM-style ``` ```mermaid ``` docs render the same as the directive form. This was a deliberate reversal of `083f590` (which had dropped fence support); any other language tag still falls through to a plain CODE block.

{termrender-3.0.2 → termrender-4.0.0}/src/termrender/__main__.py

@@ -78,7 +78,7 @@ Document format
   :::divider{label=""}                    labeled horizontal rule
   :::code{lang=""}                        syntax-highlighted block (``` fences also work)
   :::quote{author=""}                     attributed block quote
-  :::mermaid                             flowchart → ASCII (NOT ```mermaid fences)
+  :::mermaid                             flowchart → ASCII (``` mermaid fences also work)
 """
 
 _DOC_RENDER_HELP = """\

{termrender-3.0.2 → termrender-4.0.0}/src/termrender/parser.py

@@ -303,10 +303,21 @@ def _convert_ast(nodes: list[dict], _depth: int = 0) -> list[Block]:
         elif ntype == "block_code":
             raw = node.get("raw", "")
             info = node.get("attrs", {}).get("info", "")
-            blocks.append(Block(
-                type=BlockType.CODE,
-                attrs={"lang": info, "source": raw},
-            ))
+            # A ```mermaid fence is GFM's standard way to tag a mermaid diagram
+            # (GitHub, and most docs/agents that don't know this project's
+            # :::mermaid directive, use this form) — route it through the
+            # mermaid renderer same as :::mermaid, instead of a plain code panel.
+            lang = info.split()[0].lower() if info.split() else ""
+            if lang == "mermaid":
+                blocks.append(Block(
+                    type=BlockType.MERMAID,
+                    attrs={"source": raw},
+                ))
+            else:
+                blocks.append(Block(
+                    type=BlockType.CODE,
+                    attrs={"lang": info, "source": raw},
+                ))
 
         elif ntype == "list":
             ordered = node.get("attrs", {}).get("ordered", False)

{termrender-3.0.2 → termrender-4.0.0}/tests/test_myst_gaps.py

@@ -7,7 +7,7 @@ from termrender.parser import parse, _strip_options
 
 
 class TestMermaidDirective(unittest.TestCase):
-    """:::mermaid is the only fence form for mermaid diagrams."""
+    """:::mermaid and ```mermaid fences both produce mermaid diagrams."""
 
     def test_basic_mermaid_directive(self):
         """:::mermaid\ngraph LR\nA-->B\n::: → BlockType.MERMAID"""
@@ -26,12 +26,12 @@ class TestMermaidDirective(unittest.TestCase):
         self.assertIn("graph LR", block.attrs["source"])
         self.assertNotIn(":title:", block.attrs["source"])
 
-    def test_backtick_mermaid_is_plain_code_block(self):
-        """```mermaid is no longer a mermaid block — it renders as a code block."""
+    def test_backtick_mermaid_is_mermaid_block(self):
+        """```mermaid fences route through the mermaid renderer, same as :::mermaid."""
         doc = parse("```mermaid\ngraph LR\nA-->B\n```")
         block = doc.children[0]
-        self.assertEqual(block.type, BlockType.CODE)
-        self.assertEqual(block.attrs.get("lang"), "mermaid")
+        self.assertEqual(block.type, BlockType.MERMAID)
+        self.assertIn("graph LR", block.attrs["source"])
 
     def test_backtick_directive_is_plain_code_block(self):
         """```{panel} is no longer a directive — it renders as a code block."""