# @contentful/rich-text-from-markdown 中文文档

规范地址：https://npmcn.com/package/%40contentful/rich-text-from-markdown/

版本：16\.2\.2
npm 元数据更新时间：2026-07-21T08:50:52.945Z
中文译文更新时间：2026-11-10T16:36:03.409Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40contentful/rich-text-from-markdown
原文对照：https://npmcn.com/package/%40contentful/rich-text-from-markdown/?lang=original
项目主页：https://github.com/contentful/rich-text#readme
源码仓库：https://github.com/contentful/rich-text

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

- 包体积（解压后）：150 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2018-11-08T10:03:18.293Z
- 最新版本发布：2026-07-21T08:50:52.709Z
- 近 30 天下载量：411621（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：90（近 12 个月 3 个）

## 中文简介

将下标记转换为丰富文本

## 安装

```sh
npm install @contentful/rich-text-from-markdown
```

也可以使用：`pnpm add @contentful/rich-text-from-markdown`、`yarn add @contentful/rich-text-from-markdown`、`bun add @contentful/rich-text-from-markdown`

## README

# 富文本自标记

一个将缩放转换为 Contentful Rich Text 文档格式的库 .

## 安装

使用 [无](http://npmjs.org/)数字 :

```sh
npm install @contentful/rich-text-from-markdown
```

使用 [线条](https://yarnpkg.com/)数字 :

```sh
yarn add @contentful/rich-text-from-markdown
```

## 使用量

### 基础

```js
const { richTextFromMarkdown } = require('@contentful/rich-text-from-markdown');

const document = await richTextFromMarkdown('# Hello World');
```

### 高级

库会自动转换以下标记下节点:

-   `paragraph`
-   `heading`
-   `text`
-   `emphasis`
-   `strong`
-   `delete`
-   `inlineCode`
-   `link`
-   `thematicBreak`
-   `blockquote`
-   `list`
-   `listItem`
-   `table`
-   `tableRow`
-   `tableCell`

如果标记下的内容有像图像这样的不支持的节点 `![image](url)` 您可以添加回调作为第二个参数 每次找到一个不支持的节点 都会叫它 回调的回调值将是丰富的文本代表 那个节点.

#### 示例

```js
const { richTextFromMarkdown } = require('@contentful/rich-text-from-markdown');

// define your own type for unsupported nodes like asset
const document = await richTextFromMarkdown(
  "![image]('https://example.com/image.jpg')",
  (node) => ({
    nodeType: 'embedded-[entry|asset]-[block|inline]',
    content: [],
    data: {
      target: {
        sys: {
          type: 'Link',
          linkType: 'Entry|Asset',
          id: '.........',
        },
      },
    },
  }),
);
```

## 常见问题

### @contentful/rich-text-from-markdown 是什么？

将下标记转换为丰富文本

### 如何安装 @contentful/rich-text-from-markdown？

在项目目录运行 npm install @contentful/rich-text-from-markdown，或使用 pnpm add / yarn add / bun add。

### @contentful/rich-text-from-markdown 支持 TypeScript 吗？

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

### @contentful/rich-text-from-markdown 支持 ESM 还是 CommonJS？

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

### @contentful/rich-text-from-markdown 可以商用吗？

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

### @contentful/rich-text-from-markdown 的下载量有多少？

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

### @contentful/rich-text-from-markdown 还在维护吗？

最新版本 16\.2\.2 发布于 2026/07/21（3 个月前）；至今共发布 90 个版本，其中过去 12 个月发布了 3 个；首次发布于 2018/11/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。