Skip to content

fix(markdown): support nested lists in markdown component #2624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 3, 2025
Merged

fix(markdown): support nested lists in markdown component #2624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
571ded6
fix(markdown): support nested lists in markdown component
actuallyzefe Nov 1, 2025
66d72aa
Merge branch 'canary' into fix/nested-lists-2599
gabrielmfern Nov 3, 2025
cab70a7
remove comment
gabrielmfern Nov 3, 2025
85e1954
add changeset
gabrielmfern Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/angry-lights-turn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@react-email/markdown": patch
---

fix nested lists not working
5 changes: 5 additions & 0 deletions .changeset/silent-maps-fail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@react-email/components": patch
---

markdown: fix nested lists not working
18 changes: 18 additions & 0 deletions packages/markdown/src/__snapshots__/markdown.spec.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,24 @@ exports[`<Markdown> component renders correctly > renders lists in the correct f
</div><!--/$-->"
`;

exports[`<Markdown> component renders correctly > renders nested lists in the correct format for browsers 1`] = `
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><!--$--><div data-id="react-email-markdown"><ul>
<li><p>parent list item</p>
<ul>
<li>nested list item 1</li>
<li>nested list item 2</li>
</ul>
</li>
<li><p>another parent item</p>
<ol>
<li>nested ordered item 1</li>
<li>nested ordered item 2</li>
</ol>
</li>
</ul>
</div><!--/$-->"
`;

exports[`<Markdown> component renders correctly > renders text in the correct format for browsers 1`] = `
"<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><!--$--><div data-id="react-email-markdown"><p><strong style="font:700 23px / 32px &#x27;Roobert PRO&#x27;, system-ui, sans-serif;background:url(&#x27;path/to/image&#x27;)">This is sample bold text in markdown</strong> and <em style="font-style:italic">this is italic text</em></p>
</div><!--/$-->"
Expand Down
16 changes: 16 additions & 0 deletions packages/markdown/src/markdown.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,20 @@ console.log(\`Hello, $\{name}!\`);
);
expect(actualOutput).toMatchSnapshot();
});

it('renders nested lists in the correct format for browsers', async () => {
const actualOutput = await render(
<Markdown>
{`
- parent list item
- nested list item 1
- nested list item 2
- another parent item
1. nested ordered item 1
2. nested ordered item 2
`}
</Markdown>,
);
expect(actualOutput).toMatchSnapshot();
});
});
5 changes: 4 additions & 1 deletion packages/markdown/src/markdown.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,10 @@ export const Markdown = React.forwardRef<HTMLDivElement, MarkdownProps>(
};

renderer.listitem = ({ tokens }) => {
const text = renderer.parser.parseInline(tokens);
const hasNestedList = tokens.some((token) => token.type === 'list');
const text = hasNestedList
? renderer.parser.parse(tokens)
: renderer.parser.parseInline(tokens);

return `<li${
parseCssInJsToInlineCss(finalStyles.li) !== ''
Expand Down
Loading