Gathering detailed insights and metrics for @react-email/markdown
Gathering detailed insights and metrics for @react-email/markdown
Installations
npm install @react-email/markdownDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Min. Node Version
>=18.0.0
Node Version
23.7.0
NPM Version
10.9.2
Score
98.2
Supply Chain
96.4
Quality
85.7
Maintenance
100
Vulnerability
99.6
License
Releases
245
react-email@4.1.0-canary.12
react-email@4.1.0-canary.12
Updated on Jul 04, 2025
@react-email/preview-server@4.1.0-canary.12
@react-email/preview-server@4.1.0-canary.12
Updated on Jul 04, 2025
react-email@4.0.17
react-email@4.0.17
Updated on Jun 24, 2025
@react-email/render@1.1.3
@react-email/render@1.1.3
Updated on Jun 24, 2025
@react-email/components@0.1.1
@react-email/components@0.1.1
Updated on Jun 24, 2025
@react-email/code-block@0.1.0
@react-email/code-block@0.1.0
Updated on Jun 16, 2025
Languages
5
TypeScript
MDX
JavaScript
CSS
HTML
TypeScript (94.83%)
MDX (4.69%)
JavaScript (0.45%)
CSS (0.01%)
HTML (0.01%)
Developer
Download Statistics
Total Downloads
19,404,914
Last Day
31,523
Last Week
627,214
Last Month
2,691,883
Last Year
17,790,115
GitHub Statistics
MIT License
16,121 Stars
1,610 Commits
777 Forks
36 Watchers
96 Branches
158 Contributors
Updated on Jul 04, 2025
Bundle Size
44.90 kB
Minified
14.01 kB
Minified + Gzipped
Maintainers
3
Package Meta Information
Latest Version
0.0.15
Package Id
@react-email/markdown@0.0.15
Unpacked Size
12.60 kB
Size
3.79 kB
File Count
7
NPM Version
10.9.2
Node Version
23.7.0
Published on
May 01, 2025
Total Downloads
Cumulative downloads
Total Downloads
19,404,914
Last Day
-5.2%
31,523
Compared to previous day
Last Week
-3.9%
627,214
Compared to previous week
Last Month
21.6%
2,691,883
Compared to previous month
Last Year
1,001.7%
17,790,115
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
1
Dev Dependencies
3
@react-email/markdown
Convert Markdown to valid React Email template code.
Install
Install component from your command line.
With yarn
1yarn add @react-email/markdown -E
With npm
1npm install @react-email/markdown -E
Getting started
Add the component around your email body content.
1import { Markdown } from "@react-email/markdown"; 2import { Html } from "@react-email/html"; 3 4const Email = () => { 5 return ( 6 <Html lang="en" dir="ltr"> 7 <Markdown 8 markdownCustomStyles={{ 9 h1: { color: "red" }, 10 h2: { color: "blue" }, 11 codeInline: { background: "grey" }, 12 }} 13 markdownContainerStyles={{ 14 padding: "12px", 15 border: "solid 1px black", 16 }} 17 >{`# Hello, World!`}</Markdown> 18 19 {/* OR */} 20 21 <Markdown children={`# This is a ~~strikethrough~~`} /> 22 </Html> 23 );
Props
children field
- Type: string
Contains the markdown content that will be rendered in the email template.
markdownCustomStyles field
- Type: object
- Default:
{}
Provide custom styles for the corresponding HTML element (e.g., p, h1, h2, etc.).
markdownContainerStyles field
- Type: object
- Default:
{}
Provide custom styles for the containing div that wraps the markdown content.
Support
This component was tested using the most popular email clients.
 |  |  |  |  |  |
|---|---|---|---|---|---|
| Gmail ✔ | Apple Mail ✔ | Outlook ✔ | Yahoo! Mail ✔ | HEY ✔ | Superhuman ✔ |
License
MIT License
No vulnerabilities found.
No security vulnerabilities found.