![React Email Markdown cover](https://react.email/static/covers/markdown.png)

@react-email/markdown

Convert Markdown to valid React Email template code.

## Install Install component from your command line. #### With yarn ```sh yarn add @react-email/markdown -E ``` #### With npm ```sh 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 ( {`# Hello, World!`} {/* OR */} ); ``` ## 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