0.0.12 • Published 10 months ago

@react-email/markdown v0.0.12

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

React Email Markdown cover

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

reactemailmarkdown
md-to-react-email
@everything-registry/sub-chunk-763@coursebuilder/email-templates@react-email/componentspropro-auth-middleware
0.0.11

11 months ago

0.0.12

10 months ago

0.0.12-canary.0

11 months ago

0.0.11-canary.1

11 months ago

0.0.11-canary.0

12 months ago

0.0.10

1 year ago

0.0.9

1 year ago

0.0.9-canary.0

1 year ago

0.0.2

2 years ago

0.0.8

2 years ago

0.0.5

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.1

2 years ago