md-to-react-email is a lightweight utility for converting Markdown into valid React-email templates. This tool simplifies the process of creating responsive and customizable email templates by leveraging the power of React and Markdown.

Support

The following markdown flavors are supported

Offical markdown flavour
Github flavoured markdown

Installation

Install from your command line.

With yarn

yarn add md-to-react-email

With npm

npm install md-to-react-email

Features

Functions:

camelToKebabCase: converts strings from camelcase ['thisIsCamelCase'] to kebab case ['this-is-kebab-case']
parseCssInJsToInlineCss: converts css styles from css-in-js to inline css e.g fontSize: "18px" => font-size: 18px;
parseMarkdownToReactEmail: parses markdown to a valid react-email string that can be copied and pasted directly into your codebase
parseMarkdownToReactEmailJSX: parses markdown to valid react-email JSX for the client (i.e the browser)

Components:

ReactEmailMarkdown: a react-email component that takes in markdown input and parses it directly in your code base

Usage:

Directly as React-email component

  ```
  import {ReactEmailMarkdown} from "md-to-react-email"

  export default function EmailTemplate() {
  return (
          <Email>
                  <Head />
                  <Section>
                  <ReactEmailMarkdown markdown={`# Hello, World!`} />
                  </Section>
          </Email>
  )
  }
  ```

Directly into react-email template

  ```
  import {parseMarkdownToReactEmailJSX} from "md-to-react-email"

  const markdown = `# Hello World`
  const parsedReactMail = parseMarkdownToReactEmail(markdown)

  console.log(parsedReactMail) // `<Heading as="h1" style="...valid inline CSS..."></Heading>`

  ```

For code generation (copy and paste)

  ```
  import {parseMarkdownToReactEmail} from "md-to-react-email"

  const markdown = `# Hello World`
  const parsedReactMail = parseMarkdownToReactEmail(markdown)

  console.log(parsedReactMail) // `<Heading as="h1" style={...styles go here...}></Heading>`

  ```

Components

md-to-react-email contains pre-defined react-email and html components for the email template structure and styling. You can modify these components to customize the look and feel of your email template.

The following components are available for customization:

Headers (h1 - h6)
BlockQuotes
Text: paragraphs, bold and italic text
Links
Code: Code blocks and inline code
Lists: ul, li
Image
Line-breaks (br)
Horizontal-rule (hr)

Supported Email Clients

The provided React-email components and default styling are designed to work well across various email clients and providers. However, due to the inconsistent support for modern web standards in different email clients, it's recommended to test your email templates in multiple clients to ensure compatibility.

The following email clients are known to be supported:

Gmail
Apple Mail
Outlook (desktop and web)
Yahoo Mail
HEY Mail
Super Human


Gmail ✔	Apple Mail ✔	Outlook ✔	Yahoo! Mail ✔	HEY ✔	Superhuman ✔

Contributing

Contributions to md-to-react-email are welcome! If you find a bug, have suggestions for improvements, or want to add new features, feel free to open an issue or submit a pull request. Please make sure to follow the existing coding style and conventions.

When submitting a pull request, provide a clear description of the changes made and ensure that all tests pass. Adding appropriate tests for new features or bug fixes is highly appreciated.

Bugs and Feature Requests

For bugs and feature requests, please create an issue.

Author

Paul Ehikhuemen (@pauloe_me)

License

md-to-react-email is licensed under the MIT License.

Keywords

markdown

react-email

jsx

FAQs

What is md-to-react-email?

Is md-to-react-email popular?

Is md-to-react-email well maintained?

Package last updated on 19 Jun 2023

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

md-to-react-email