@jsx-email/markdown

v2.0.4

Types
ESM
CJS

A JSX email component which converts markdown input to valid HTML for email

This package has been deprecated.

The project has moved to a single package. Please install jsx-email for further updates

License: MIT
Deps: 1/-
View dependency graph Inspect dependency tree
Install Size: 12.6 kB/-
Vulns: 0
Published: Oct 23, 2023

Get started

$npm install @jsx-email/markdown@2.0.4

$pnpm add @jsx-email/markdown@2.0.4

$yarn add @jsx-email/markdown@2.0.4

$bun add @jsx-email/markdown@2.0.4

$deno add npm:@jsx-email/markdown@2.0.4

$vlt install @jsx-email/markdown@2.0.4

Readme

@jsx-email/markdown

A JSX email component which converts markdown input to valid HTML for email

@jsx-email/markdown Documentation

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 @jsx-email/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>
  );