# @assistant-ui/react-streamdown 中文文档

规范地址：https://npmcn.com/package/%40assistant-ui/react-streamdown/

版本：0\.3\.21
npm 元数据更新时间：2026-10-28T00:51:07.387Z
中文译文更新时间：2026-11-07T00:26:06.794Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40assistant-ui/react-streamdown
原文对照：https://npmcn.com/package/%40assistant-ui/react-streamdown/?lang=original
项目主页：https://www.assistant-ui.com/
源码仓库：https://github.com/assistant-ui/assistant-ui

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

- 包体积（解压后）：392 kB，68 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：react ^18 \|\| ^19，@types/react \*，@streamdown/cjk ^1\.0\.0，@streamdown/code ^1\.0\.0，@streamdown/math ^1\.0\.0，@assistant-ui/react ^0\.15\.0，@streamdown/mermaid ^1\.0\.0
- 首次发布：2026-01-29T03:19:06.494Z
- 最新版本发布：2026-10-28T00:51:07.007Z
- 近 30 天下载量：1351993（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

由下而上为助手制作的平面图

## 安装

```sh
npm install @assistant-ui/react-streamdown
```

也可以使用：`pnpm add @assistant-ui/react-streamdown`、`yarn add @assistant-ui/react-streamdown`、`bun add @assistant-ui/react-streamdown`

## README

# `@assistant-ui/react-streamdown`

[逐步减少](https://github.com/vercel/streamdown)\- 基于标记下渲染 `@assistant-ui/react`的空投替换 `@assistant-ui/react-markdown` 有内置的Shiki,KaTeX,和美人鱼支持,优化了AI流输出.

## 何时使用

| 软件包 | 最好还是 |
| --- | --- |
| `@assistant-ui/react-markdown` | 轻量级渲染; 带来自己的语法亮点 . |
| `@assistant-ui/react-streamdown` | 有内置史克,克特克,和美人鱼的特色丰富. |
| `@assistant-ui/react-syntax-highlighter` | 与 `react-markdown` 当你只需要代码块加亮. |

## 安装

```bash
npm install @assistant-ui/react @assistant-ui/react-streamdown
```

可选特性:

```bash
npm install @streamdown/code @streamdown/math @streamdown/mermaid @streamdown/cjk
```

## CSS 设置

将其控制按钮(代码-块工具栏、美人鱼全屏)和流线护栏作为Tailwind公用事业类别。 尾风 v4 不扫描 `node_modules` 默认时添加一个 `@source` 向导入 Tailwind 的样式表下流指令( 以及每个安装的插件一个) :

```css
@import "tailwindcss";

@source "../node_modules/streamdown/dist/*.js";
@source "../node_modules/@streamdown/code/dist/*.js";
@source "../node_modules/@streamdown/math/dist/*.js";
@source "../node_modules/@streamdown/mermaid/dist/*.js";
@source "../node_modules/@streamdown/cjk/dist/*.js";
```

调整您的项目的相对路径 `node_modules`。在一个pnpm 或 Turbo 单曲中,你通常需要更多 `../` 块以到达工作空间根。 只保留您实际安装的软件包的插件行 .

没有这些指令,复制、下载和全屏按钮就会变形 `caret` 指标保持不变.

如果你使用 `animated` 道具或 `createAnimatePlugin` 对于单词级的淡出, 也可以在您的应用程序条目中导入一次密钥框 :

```ts
import "streamdown/styles.css";
```

有关Shadcn/ui设计标志的详情,请参见 [向下流读取](https://github.com/vercel/streamdown#css-custom-properties-design-tokens)。 。 。 .

## 使用量

```tsx
import { StreamdownTextPrimitive } from "@assistant-ui/react-streamdown";
import { code } from "@streamdown/code";
import { math } from "@streamdown/math";
import { mermaid } from "@streamdown/mermaid";
import "katex/dist/katex.min.css";

export const MarkdownText = () => (
  <StreamdownTextPrimitive
    plugins={{ code, math, mermaid }}
    shikiTheme={["github-light", "github-dark"]}
  />
);
```

完整道具参考、插件文件、性能指南和 `react-markdown` 移民笔记 [助理-ui.com/docs/指南/下游](https://www.assistant-ui.com/docs/guides/streamdown)。 。 。 .

## 常见问题

### @assistant-ui/react-streamdown 是什么？

由下而上为助手制作的平面图

### 如何安装 @assistant-ui/react-streamdown？

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

### @assistant-ui/react-streamdown 支持 TypeScript 吗？

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

### @assistant-ui/react-streamdown 支持 ESM 还是 CommonJS？

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

### @assistant-ui/react-streamdown 可以商用吗？

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

### @assistant-ui/react-streamdown 的下载量有多少？

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

### @assistant-ui/react-streamdown 还在维护吗？

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