npmpackage.info

@jsx-email/markdown

Build emails with a delightful DX

2.0.4

1,105

MIT

TypeScript

13.83 kB

36,709

Installations

npm install @jsx-email/markdown

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=18.0.0

Node Version

18.16.1

NPM Version

9.5.1 Score

70.8

Supply Chain

89.5

Quality

74.9

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

2

Total

174

Closed

6

Merged

166

Issues

Open

4

Total

96

Closed

92

Releases

Unable to fetch releases

Contributors

114

View all 114 contributors

Languages

TypeScript

CSS

JavaScript

Shell

Mustache

HTML

TypeScript (93.98%)

CSS (2.19%)

JavaScript (2.06%)

Shell (0.94%)

Mustache (0.55%)

HTML (0.28%)

Developer

shellscape

Download Statistics

Total Downloads

36,709

Last Day

178

Last Week

947

Last Month

3,221

Last Year

22,924

GitHub Statistics

1,105 Stars

1,263 Commits

44 Forks

5 Watching

8 Branches

114 Contributors

Bundle Size

44.17 kB

Minified

13.83 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/shellscape

Maintainers

Package Meta Information

Latest Version

2.0.4

Package Id

@jsx-email/markdown@2.0.4

Unpacked Size

12.26 kB

Size

4.00 kB

File Count

NPM Version

9.5.1

Node Version

18.16.1

Publised On

23 Oct 2023

Total Downloads

Cumulative downloads

Total Downloads

36,709

Last day

1.7%

178

Compared to previous day

Last week

18.5%

947

Compared to previous week

Last month

158.7%

3,221

Compared to previous month

Last year

66.3%

22,924

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

md-to-react-email

Peer Dependencies

react

Versions

@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

1pnpm add @jsx-email/markdown
2
3# We recommend pnpm - https://pnpm.io
4# But npm and yarn are supported
5# npm add @jsx-email/markdown
6# 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:

1import { Markdown } from "@jsx-email/markdown";
2import { Html } from "@jsx-email/html";
3
4const Email = () => {
5  return (
6    <Html lang="en" dir="ltr">
7      <Markdown
8        markdownCustomStyles={{
9          h1: { color: "red" },
10          h2: { color: "blue" },
11          codeInline: { background: "grey" },
12        }}
13        markdownContainerStyles={{
14          padding: "12px",
15          border: "solid 1px black",
16        }}
17      >{`# Hello, World!`}</Markdown>
18
19      {/* OR */}
20
21      <Markdown children={`# This is a ~~strikethrough~~`} />
22    </Html>
23  );

Please see the @jsx-email/markdown Documentation for props and additional usage information.

Attribution 🧡

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

License

MIT License

No vulnerabilities found.

No security vulnerabilities found.

Other packages similar to @jsx-email/markdown

md-to-react-email

5.0.5

A simple Markdown to jsx parser for email templates written in typescript.