# @conversion-ai/md-to-react-email 中文文档

规范地址：https://npmcn.com/package/%40conversion-ai/md-to-react-email/

版本：5\.0\.5-revision\.5
npm 元数据更新时间：2025-09-11T00:29:19.667Z
中文译文更新时间：2026-11-10T17:27:53.766Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40conversion-ai/md-to-react-email
原文对照：https://npmcn.com/package/%40conversion-ai/md-to-react-email/?lang=original
项目主页：https://github.com/tapp-ai/md-to-react-email#readme
源码仓库：https://github.com/tapp-ai/md-to-react-email

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：66.3 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18\.0 \|\| ^19\.0
- 首次发布：2025-06-04T19:55:23.314Z
- 最新版本发布：2025-09-11T00:29:19.168Z
- 近 30 天下载量：14583（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

一个简单的 Markdown 到 jsx 解析器, 用于写入打字符的电子邮件模板 .

## 安装

```sh
npm install @conversion-ai/md-to-react-email
```

也可以使用：`pnpm add @conversion-ai/md-to-react-email`、`yarn add @conversion-ai/md-to-react-email`、`bun add @conversion-ai/md-to-react-email`

## README

# md- to- react- 邮件

读取文档 [这里](https://md2re.codeskills.dev/)

## 说明

md- to- react-email 是用于转换的轻量级工具 [标记](https://www.markdownguide.org/) 可用于下列目的的有效JSX [回复电子邮件](https://react.email/) 或者说 [JSX电子邮件](https://jsx.email/) 模板。 这个工具通过利用React和Markdown的力量,简化了创建响应和自定义的电子邮件模板的过程.

**说明**: 从 `version 4`, (中文(简体) ), `md-to-react-email` 用途 [`Marked`](https://marked.js.org/) 用于平分转换。 查看所有更改 [这里](https://npmcn.com/CHANGELOG.md)

### 支助

支持下面的下标口味

-   外加减价口味

## 安装

从命令行安装 .

#### 用纱线

```sh
yarn add md-to-react-email
```

#### 与 npm 关系

```sh
npm install md-to-react-email
```

## 特征

### 函数 :

-   `camelToKebabCase`: 从骆驼箱将字符串 \['This IsCamelCase'\] 转换为kebab case \['This-is-kebab- case'\]
-   `parseCssInJsToInlineCss`: 将 Css 样式由 cs- in- js 转换为内置 css 如: 字体Size : "18px" QQ字体大小: 18px;
-   `parseMarkdownToJSX`: 为客户端(即浏览器)将标记降为有效的 JSX

### 组件 :

-   `EmailMarkdown`: 反应元件,在标记下输入并直接在代码基中解析

## 用法 :

-   直接作为 [`React-email`](https://react.email/) 或者说 [`JSX-email`](https://jsx.email/) 组件
    
    ```
      ```
      import {EmailMarkdown} from "md-to-react-email"
    
      export default function EmailTemplate() {
      return (
              <Email>
                      <Head />
                      <Section>
                      <EmailMarkdown markdown={`# Hello, World!`} />
                      </Section>
              </Email>
      )
      }
      ```
    ```
    
-   直接输入反应电子邮件模板
    
    ```
      ```
      import {parseMarkdownToJSX} from "md-to-react-email"
    
      const markdown = `# Hello World`
      const parsedReactMail = parseMarkdownToJSX({markdown})
    
      console.log(parsedReactMail) // `<h1 style="...valid inline CSS...">Hello, World!</h1>`
      ```
    ```
    

## 构成部分

md-to-react-email包含电子邮件模板结构和造型的预定义反应和html组件. 您可以修改这些组件以自定义您的电子邮件模板的外观和感觉 .

以下组件可供定制:

-   标题 (h1 - h6)
-   块引用
-   案文:段落、粗体和斜体文本
-   链接
-   代码:代码块和内置代码
-   列表: ul, ol, li
-   图像
-   换行( br)
-   水平规则( r)
-   表格:表、图、图、图
-   切换

## 支持的电子邮件客户端

提供的React组件和默认的外形设计是为了在各种电子邮件客户端和提供商之间很好地发挥作用. 然而,由于不同电子邮件客户端对现代网络标准的支持不一致,建议在多个客户端中测试您的电子邮件模板以确保兼容性.

已知支持以下电子邮件客户端:

-   邮件
-   苹果邮件
-   展望(桌面和网络)
-   雅虎邮件
-   嘿,邮件
-   超级人类

| ![Gmail logo](https://react.email/static/icons/gmail.svg) | ![Apple Mail](https://react.email/static/icons/apple-mail.svg) | ![Outlook logo](https://react.email/static/icons/outlook.svg) | ![Yahoo! Mail logo](https://react.email/static/icons/yahoo-mail.svg) | ![HEY logo](https://react.email/static/icons/hey.svg) | ![Superhuman logo](https://react.email/static/icons/superhuman.svg) |
| --- | --- | --- | --- | --- | --- |
| Gmail 邮件 | 苹果邮件QQ | 展望 | 亚虎! 邮件QQ | 哎哟哟 | 超级人类 |

## 捐款

欢迎向md-to-react-mail捐款! 如果您找到错误,有改进建议,或者想要添加新的特性,可以随意打开一个问题或提交拉出请求. 请遵循现有的编码样式和惯例 .

在提交拉力请求时,提供对所做出更改的清晰描述并确保所有测试通过. 加入对新特性或错误修正的适当测试受到高度赞赏.

## 错误和特性请求

对于错误和特性请求, [请创建一个问题](https://github.com/codeskills-dev/md-to-react-mail/issues/new/choose)。 。 。 .

## 作者

-   保罗·艾克赫门(Paul Ehikhuemen)[@paoule 我](https://twitter.com/pauloe_me)(中文(简体) )

## 许可证

`md-to-react-email` 根据麻省理工学院的许可证颁发执照.

## 常见问题

### @conversion-ai/md-to-react-email 是什么？

一个简单的 Markdown 到 jsx 解析器, 用于写入打字符的电子邮件模板 \.

### 如何安装 @conversion-ai/md-to-react-email？

在项目目录运行 npm install @conversion-ai/md-to-react-email，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0 \|\| ^19\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @conversion-ai/md-to-react-email 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @conversion-ai/md-to-react-email 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @conversion-ai/md-to-react-email 可以商用吗？

@conversion-ai/md-to-react-email 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @conversion-ai/md-to-react-email 的下载量有多少？

根据 npm 官方下载统计，@conversion-ai/md-to-react-email 在 2026/10/11 – 2026/11/09 这 30 天内被下载 14,583 次，日均约 486 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @conversion-ai/md-to-react-email 还在维护吗？

最新版本 5\.0\.5-revision\.5 发布于 2025/09/11（1\.2 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/06/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。