# @edwinjoseph/prismic-richtext-markdown 中文文档

规范地址：https://npmcn.com/package/%40edwinjoseph/prismic-richtext-markdown/

版本：1\.2\.5
npm 元数据更新时间：2022-04-05T06:45:14.004Z
中文译文更新时间：2026-11-13T07:46:01.727Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：224 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2020-09-08T18:14:02.743Z
- 最新版本发布：2020-09-08T19:57:42.860Z
- 近 30 天下载量：4248（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

一种将 Prismic 丰富的文本blob 转换成 mark down 字符串的方法.

## 安装

```sh
npm install @edwinjoseph/prismic-richtext-markdown
```

也可以使用：`pnpm add @edwinjoseph/prismic-richtext-markdown`、`yarn add @edwinjoseph/prismic-richtext-markdown`、`bun add @edwinjoseph/prismic-richtext-markdown`

## README

# 倾斜的 RichText 标记下

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/edwinjoseph/prismic-richtext-markdown/CI?style=flat-square)](https://github.com/edwinjoseph/prismic-richtext-markdown/actions?query=branch%3Amaster) [![npm](https://img.shields.io/npm/v/@edwinjoseph/prismic-richtext-markdown?label=%40edwinjoseph%2Fprismic-richtext-markdown&style=flat-square)](https://www.npmjs.com/package/@edwinjoseph/prismic-richtext-markdown)

**注: 此软件包只支持 Prismic API V2, 如果您正在使用 V1 , 您可以使用此软件包, 但需要重新绘制正在传递的富文本 blob 。 虽然这没有被通知.**

这是一种将出自Prismic的RichText字段的数据转换为平分字符串的方法.

### 支持的选项

-   [x] 标题1-6
-   [x] 粗体
-   [x] 斜体
-   [x] 图像
-   [x] 链接到网络
-   [x] 链接媒体
-   [x] 链接到文档
-   [x] 有序名单
-   [x] 无序列表
-   [x] 预格式化
-   [ ] 内嵌
-   [ ] 右对左

### 已确认的 markdown 软件包

这种方法最有可能与大多数减值软件包相配合,不过我只用:

-   [x] [缩放](https://www.npmjs.com/package/markdown-it)

## 使用量

### 示例棱镜文档

```
{
  "id": "WKxlPCUEEIZ10AHU",
  "uid": "example-page",
  "type": "page",
  "href": "https://your-repo-name.prismic.io/api/documents/search...",
  "tags": [],
  "first_publication_date": "2017-01-13T11:45:21.000Z",
  "last_publication_date": "2017-02-21T16:05:19.000Z",
  "slugs": [
    "example-page"
  ],
  "linked_documents": [],
  "lang": "en-us",
  "alternate_languages": [...],
  "data": {
    "title": [
      {
        "type": "heading1",
        "text": "Example Page",
        "spans": []
      }
    ]
  }
}
```

### 处理丰富文本

```js
import MarkdownIt from 'markdown-it';
import richTextToMarkdown from '@edwinjoseph/prismic-richtext-markdown';

// resolver function example from https://prismic.io/docs/javascript/beyond-the-api/link-resolving
const linkResolver = (doc) => {
  // Pretty URLs for known types
  if (doc.type === 'blog') return "/post/" + doc.uid;
  if (doc.type === 'page') return "/" + doc.uid;
  // Fallback for other types, in case new custom types get created
  return "/doc/" + doc.id;
};

const md = new MarkdownIt();

const mkdown = richTextToMarkdown(document.data.title, linkResolver);
const result = md.render(mkdown);
// => <h1>Example Page</h1>
```

## 常见问题

### @edwinjoseph/prismic-richtext-markdown 是什么？

一种将 Prismic 丰富的文本blob 转换成 mark down 字符串的方法\.

### 如何安装 @edwinjoseph/prismic-richtext-markdown？

在项目目录运行 npm install @edwinjoseph/prismic-richtext-markdown，或使用 pnpm add / yarn add / bun add。

### @edwinjoseph/prismic-richtext-markdown 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/edwinjoseph\_\_prismic-richtext-markdown 是否存在。

### @edwinjoseph/prismic-richtext-markdown 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @edwinjoseph/prismic-richtext-markdown 可以商用吗？

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

### @edwinjoseph/prismic-richtext-markdown 的下载量有多少？

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

### @edwinjoseph/prismic-richtext-markdown 还在维护吗？

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