Readme

<div align="center"><strong>@react-email/markdown</strong></div> <div align="center">Convert Markdown to valid React Email template code.</div> <div align="center"> <a href="https://react.email">Website</a> <span> · </span> <a href="https://react.email">Documentation</a> <span> · </span> <a href="https://react.email">Twitter</a> </div>

Install

Install component from your command line.

With yarn

yarn add @react-email/markdown -E

With npm

npm install @react-email/markdown -E

Getting started

Add the component around your email body content.

jsx

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>

      <Markdown children={`# This is a ~~strikethrough~~`} />
    </Html>
  );

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