clean up footnotes, add ast option type

quantizor · quantizor · commit fe95c02f111a · 2025-10-26T02:03:52.000-04:00
diff --git a/.changeset/ten-turtles-doubt.md b/.changeset/ten-turtles-doubt.md
@@ -0,0 +1,5 @@
+---
+'markdown-to-jsx': patch
+---
+
+Remove unnecessary wrapper when footnotes are present.
diff --git a/index.compiler.spec.tsx b/index.compiler.spec.tsx
@@ -4355,20 +4355,18 @@ describe('footnotes', () => {
 
     expect(root.innerHTML).toMatchInlineSnapshot(`
       <div>
-        <div>
-          <p>
-            foo
-            <a href="#abc">
-              <sup>
-                abc
-              </sup>
-            </a>
-            bar
-          </p>
-          <p>
-            After footnotes content
-          </p>
-        </div>
+        <p>
+          foo
+          <a href="#abc">
+            <sup>
+              abc
+            </sup>
+          </a>
+          bar
+        </p>
+        <p>
+          After footnotes content
+        </p>
         <footer>
           <div id="abc">
             abc: Baz
@@ -5120,7 +5118,7 @@ it('correctly parses YAML front matter inside a code block', () => {
       </code>
     </pre>
   `)
-});
+})
 
 it('handles a holistic example', () => {
   const md = fs.readFileSync(__dirname + '/fixture.md', 'utf8')
diff --git a/index.tsx b/index.tsx
@@ -1569,7 +1569,9 @@ export function compiler(
     )
   }
 
-  function compile(input: string): React.JSX.Element | React.ReactNode[] {
+  function compile(
+    input: string
+  ): React.JSX.Element | React.ReactNode[] | MarkdownToJSX.ASTNode[] {
     input = input.replace(FRONT_MATTER_R, '')
 
     let inline = false
@@ -1584,16 +1586,20 @@ export function compiler(
       inline = SHOULD_RENDER_AS_BLOCK_R.test(input) === false
     }
 
-    const arr = emitter(
-      parser(
-        inline
-          ? input
-          : `${trimEnd(input).replace(TRIM_STARTING_NEWLINES, '')}\n\n`,
-        {
-          inline,
-        }
-      )
-    ) as React.ReactNode[]
+    const astNodes = parser(
+      inline
+        ? input
+        : `${trimEnd(input).replace(TRIM_STARTING_NEWLINES, '')}\n\n`,
+      {
+        inline,
+      }
+    )
+
+    if (options.ast) {
+      return astNodes
+    }
+
+    const arr = emitter(astNodes) as React.ReactNode[]
 
     while (
       isString(arr[arr.length - 1]) &&
@@ -1602,6 +1608,21 @@ export function compiler(
       arr.pop()
     }
 
+    if (footnotes.length) {
+      arr.push(
+        <footer key="footer">
+          {footnotes.map(function createFootnote(def) {
+            return (
+              <div id={slug(def.identifier, slugify)} key={def.identifier}>
+                {def.identifier}
+                {emitter(parser(def.footnote, { inline: true }))}
+              </div>
+            )
+          })}
+        </footer>
+      )
+    }
+
     if (options.wrapper === null) {
       return arr
     }
@@ -2269,24 +2290,6 @@ export function compiler(
     console.log('Parse invocations:', parseCountsWithNames)
   }
 
-  if (footnotes.length) {
-    return (
-      <div>
-        {jsx}
-        <footer key="footer">
-          {footnotes.map(function createFootnote(def) {
-            return (
-              <div id={slug(def.identifier, slugify)} key={def.identifier}>
-                {def.identifier}
-                {emitter(parser(def.footnote, { inline: true }))}
-              </div>
-            )
-          })}
-        </footer>
-      </div>
-    )
-  }
-
   return jsx
 }
 
@@ -2627,6 +2630,12 @@ export namespace MarkdownToJSX {
   }
 
   export type Options = Partial<{
+    /**
+     * When true, returns the parsed AST instead of rendered JSX.
+     * Footnotes are not automatically appended; the consumer handles them.
+     */
+    ast: boolean
+
     /**
      * Ultimate control over the output of all rendered JSX.
      */

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'markdown-to-jsx': patch
 +---
++
 +Remove unnecessary wrapper when footnotes are present.