footnotes: Add Markdown rendering for inline footnotes

commonmark · Sep 12, 2024 · e3795b2 · e3795b2
1 parent c910105
commit e3795b2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/...tes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java b/...tes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java
@@ -2,6 +2,7 @@
 
 import org.commonmark.ext.footnotes.FootnoteDefinition;
 import org.commonmark.ext.footnotes.FootnoteReference;
+import org.commonmark.ext.footnotes.InlineFootnote;
 import org.commonmark.node.*;
 import org.commonmark.renderer.NodeRenderer;
 import org.commonmark.renderer.html.HtmlNodeRendererContext;
@@ -26,13 +27,15 @@ public FootnoteMarkdownNodeRenderer(MarkdownNodeRendererContext context) {
 
     @Override
     public Set<Class<? extends Node>> getNodeTypes() {
-        return Set.of(FootnoteReference.class, FootnoteDefinition.class);
+        return Set.of(FootnoteReference.class, InlineFootnote.class, FootnoteDefinition.class);
     }
 
     @Override
     public void render(Node node) {
         if (node instanceof FootnoteReference) {
             renderReference((FootnoteReference) node);
+        } else if (node instanceof InlineFootnote) {
+            renderInline((InlineFootnote) node);
         } else if (node instanceof FootnoteDefinition) {
             renderDefinition((FootnoteDefinition) node);
         }
@@ -45,6 +48,12 @@ private void renderReference(FootnoteReference ref) {
         writer.raw("]");
     }
 
+    private void renderInline(InlineFootnote inlineFootnote) {
+        writer.raw("^[");
+        renderChildren(inlineFootnote);
+        writer.raw("]");
+    }
+
     private void renderDefinition(FootnoteDefinition def) {
         writer.raw("[^");
         writer.raw(def.getLabel());

diff --git a/...xt-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteMarkdownRendererTest.java b/...xt-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteMarkdownRendererTest.java
@@ -11,7 +11,7 @@
 import static org.junit.Assert.assertEquals;
 
 public class FootnoteMarkdownRendererTest {
-    private static final Set<Extension> EXTENSIONS = Set.of(FootnotesExtension.create());
+    private static final Set<Extension> EXTENSIONS = Set.of(FootnotesExtension.builder().inlineFootnotes(true).build());
     private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
     private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
 
@@ -36,6 +36,11 @@ public void testBackslashInLabel() {
         assertRoundTrip("[^\\foo]\n\n[^\\foo]: note\n");
     }
 
+    @Test
+    public void testInline() {
+        assertRoundTrip("^[test *foo*]\n");
+    }
+
     private void assertRoundTrip(String input) {
         String rendered = parseAndRender(input);
         assertEquals(input, rendered);