用途:Streamdown 是面向流式场景优化的 React Markdown 渲染器,可作为 react-markdown 的替代品,用于 AI 聊天、博客与文档等需要渲染 Markdown 的界面。
主要能力:内置流式渲染支持、安全处理与交互控件;可选插件提供代码高亮(Shiki,200+ 语言)、Mermaid 图表、LaTeX 数学公式(KaTeX)以及中文/日文/韩文支持。通过 mode 属性可切换 "streaming" 与 "static" 两种渲染模式。
使用方式:先安装 npm install streamdown,按需安装插件 npm install @streamdown/code @streamdown/mermaid @streamdown/math @streamdown/cjk。必须配置 Tailwind 扫描 dist 文件:Tailwind v4 在 globals.css 中添加 @source "../node_modules/streamdown/dist/.js";(已安装插件也需对应添加 @source 行);Tailwind v3 则在 tailwind.config.js 的 content 中加入 "./node_modules/streamdown/dist/.js"。基础用法为 import { Streamdown } from 'streamdown'; 并渲染 <Streamdown>{markdown}</Streamdown>。数学功能需导入 katex/dist/katex.min.css。
适用场景:结合 Vercel AI SDK 的 useChat 渲染 AI 回复,或用于博客、文档的静态渲染。
限制与注意事项:未配置 Tailwind @source 会导致样式缺失;数学不渲染通常因缺少 KaTeX CSS;光标显示需同时设置 caret 属性与 isAnimating={true};流式期间复制按钮自动禁用;链接安全弹窗默认开启,可用 linkSafety={{ enabled: false }} 关闭;allowedTags 仅在使用默认 rehype 插件时生效;数学默认使用 $$,单美元符号默认禁用。更多 API、插件与安全细节可参考仓库的 references 与 assets/examples 文件。