Merge pull request #338 from commonmark/issue-335-md-escaping-equals

Don't escape `=` text if it's the first node in a block
commonmark · Sep 14, 2024 · db57101 · db57101
2 parents 3785185 + 26d4df9
commit db57101
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/commonmark/src/main/java/org/commonmark/renderer/markdown/CoreMarkdownNodeRenderer.java b/commonmark/src/main/java/org/commonmark/renderer/markdown/CoreMarkdownNodeRenderer.java
@@ -370,9 +370,11 @@ public void visit(Text text) {
                     break;
                 }
                 case '=': {
-                    // Would be ambiguous with a Setext heading, escape
-                    writer.raw("\\=");
-                    literal = literal.substring(1);
+                    // Would be ambiguous with a Setext heading, escape unless it's the first line in the block
+                    if (text.getPrevious() != null) {
+                        writer.raw("\\=");
+                        literal = literal.substring(1);
+                    }
                     break;
                 }
                 case '0':

diff --git a/commonmark/src/test/java/org/commonmark/renderer/markdown/MarkdownRendererTest.java b/commonmark/src/test/java/org/commonmark/renderer/markdown/MarkdownRendererTest.java
@@ -197,6 +197,9 @@ public void testEscaping() {
         assertRoundTrip("\\## Test\n");
         assertRoundTrip("\\#\n");
         assertRoundTrip("Foo\n\\===\n");
+        // Only needs to be escaped after some text, not at beginning of paragraph
+        assertRoundTrip("===\n");
+        assertRoundTrip("a\n\n===\n");
         // The beginning of the line within the block, so disregarding prefixes
         assertRoundTrip("> \\- Test\n");
         assertRoundTrip("- \\- Test\n");