@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 852,297 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.
Research
Four npm packages disguised as cryptographic tools steal developer credentials and send them to attacker-controlled Telegram infrastructure.
Security News
Ruby maintainers from Bundler and rbenv teams are building rv to bring Python uv's speed and unified tooling approach to Ruby development.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.