Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@react-email/markdown

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@react-email/markdown

Convert Markdown to valid React Email template code.

0.0.10
Source
npm

Version published: 6 months ago

Maintainers: 3

Created: last year

Source

React Email Markdown cover

@react-email/markdown

Convert Markdown to valid React Email template code.

Website · Documentation · Twitter

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.

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

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

Keywords

FAQs

What is @react-email/markdown?

Is @react-email/markdown well maintained?

Package last updated on 29 Apr 2024

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.

Install