> ## Documentation Index
> Fetch the complete documentation index at: https://react.email/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Markdown

> A Markdown component that converts markdown to valid react-email template code

## Install

Install component from your command line.

```sh npm theme={"theme":{"light":"github-light","dark":"vesper"}}
npm install react-email -E
```

```sh yarn theme={"theme":{"light":"github-light","dark":"vesper"}}
yarn add react-email -E
```

```sh pnpm theme={"theme":{"light":"github-light","dark":"vesper"}}
pnpm add react-email -E
```

## Getting started

Add the component to your email template. Include styles where needed.

```jsx theme={"theme":{"light":"github-light","dark":"vesper"}}
import { Markdown, Html } from "react-email";

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>
  );
};
```

## Props

**children** `string`

Contains the markdown content that will be rendered in the email template

**markdownContainerStyles** `object` (default: \{})

Provide custom styles for the containing div that wraps the markdown content

**markdownCustomStyles** `object` (default: \{})

Provide custom styles for the corresponding html element (p, h1, h2, etc.)

> [!NOTE]
>
> Note: Passing a custom style for an element overrides the default styles.

## Support

All components were tested using the most popular email clients.

![Gmail](https://react.email/static/icons/gmail.svg)

Gmail

![Apple Mail](https://react.email/static/icons/apple-mail.svg)

Apple Mail

![Outlook](https://react.email/static/icons/outlook.svg)

Outlook

![Yahoo! Mail](https://react.email/static/icons/yahoo-mail.svg)

Yahoo! Mail

![HEY](https://react.email/static/icons/hey.svg)

HEY

![Superhuman](https://react.email/static/icons/superhuman.svg)

Superhuman


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.