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

@jsx-email/markdown

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@jsx-email/markdown

Convert markdown input to valid react-email synthax

1.0.0
Source
npm

Version published: last year

Maintainers: 1

Created: last year

Source

@jsx-email/markdown

A JSX email component for

Requirements

This package requires an LTS Node version (v18.0.0+) and React v18.2.0+.

Install

pnpm add @jsx-email/markdown

# We recommend pnpm - https://pnpm.io
# But npm and yarn are supported
# npm add @jsx-email/markdown
# yarn add @jsx-email/markdown

Usage

We recommend using the ../cli for creating new templates.

Create an email template file (e.g. Email.tsx) and import the component:

import { Markdown } from "@jsx-email/markdown";
import { Html } from "@jsx-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.

Attribution 🧡

This package was built upon prior work for react-email by Bu Kinoshita (@bukinoshita) and Zeno Rocha (@zenorocha).

License

MIT License

Keywords

FAQs

What is @jsx-email/markdown?

Is @jsx-email/markdown well maintained?

Package last updated on 27 Sep 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