# @discord/markdown-react 中文文档

规范地址：https://npmcn.com/package/%40discord/markdown-react/

版本：0\.11\.0
npm 元数据更新时间：2026-11-04T16:46:48.200Z
中文译文更新时间：2026-11-12T11:04:22.218Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40discord/markdown-react
原文对照：https://npmcn.com/package/%40discord/markdown-react/?lang=original

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

- 包体积（解压后）：7.7 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react 17 - 19
- 首次发布：2025-05-12T15:57:27.030Z
- 最新版本发布：2026-11-04T16:46:48.020Z
- 近 30 天下载量：341475（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 12 个）

## 中文简介

平台不可知论 渲染 Discord Markdown 的回放库

## 安装

```sh
npm install @discord/markdown-react
```

也可以使用：`pnpm add @discord/markdown-react`、`yarn add @discord/markdown-react`、`bun add @discord/markdown-react`

## README

# @ discord/ markdown- react

用于渲染Discord Markdown的平台-不可知回放库. 需要一个AST 然后把它变成反应元素.

## 使用量

```js
import { NodeList } from '@discord/markdown-react';
import { parse } from '@discord/markdown-wasm'; // or @discord/markdown-react-native

function Text({ children }) {
  return <span>{children}</span>;
}

function Paragraph({ children }) {
  return <span>{children}</span>;
}

const renderers = {
  text: Text,
  paragraph: Paragraph,
  quote: Quote,
  ...otherRenderers, // define renderers for other node types
};

export function Markdown({ content }) {
  const ast = parse(
    content,
    // without flags every syntax parses, so you must define a renderer for every node type
  );

  return <NodeList nodes={ast} renderers={renderers} />;
}
```

在节点外, `@discord/markdown-wasm` 需要一个 `await init()` 第一次选举之前 `parse`; 见 它的阅读.

如果您没有为 AST 中的节点类型提供渲染器, 渲染会 失败。 你可以通过解析器来调谐 `flags` 省去了语法 生产(例如:. `Syntax.ALL & ~Syntax.MENTIONS`或通过将渲染器添加到 `renderers`。 。 。 .

## 构建

```
pnpm build
```

## 常见问题

### @discord/markdown-react 是什么？

平台不可知论 渲染 Discord Markdown 的回放库

### 如何安装 @discord/markdown-react？

在项目目录运行 npm install @discord/markdown-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（17 - 19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @discord/markdown-react 支持 TypeScript 吗？

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

### @discord/markdown-react 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @discord/markdown-react 可以商用吗？

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

### @discord/markdown-react 的下载量有多少？

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

### @discord/markdown-react 还在维护吗？

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