@react-email/markdown
Advanced tools
Install component from your command line.
yarn add @react-email/markdown -E
npm install @react-email/markdown -E
Add the component around your email body content.
import { Markdown } from "@react-email/markdown";
import { Html } from "@react-email/html";
const Email = () => {
return (
<Html lang="en" dir="ltr">
<Markdown
markdownCustomStyles={{
h1: { color: "red" },
h2: { color: "blue" },
codeInline: { background: "grey" },
}}
markdownContainerStyles={{
padding: "12px",
border: "solid 1px black",
}}
>{`# Hello, World!`}</Markdown>
{/* OR */}
<Markdown children={`# This is a ~~strikethrough~~`} />
</Html>
);
children fieldContains the markdown content that will be rendered in the email template.
markdownCustomStyles field{}Provide custom styles for the corresponding HTML element (e.g., p, h1, h2, etc.).
markdownContainerStyles field{}Provide custom styles for the containing div that wraps the markdown content.
This component was tested using the most popular email clients.
 |  |  |  |  |  |
|---|---|---|---|---|---|
| Gmail ✔ | Apple Mail ✔ | Outlook ✔ | Yahoo! Mail ✔ | HEY ✔ | Superhuman ✔ |
MIT License
FAQs
Convert Markdown to valid React Email template code.
The npm package @react-email/markdown receives a total of 273,863 weekly downloads. As such, @react-email/markdown popularity was classified as popular.
We found that @react-email/markdown demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.