指南

Vue 3 和 Nuxt 项目直接按下面三步接入。其他框架先从 框架选择 找到对应包。

跑通 Vue 接入

1. Vue 快速开始：安装、引入 CSS，复制完整的静态或流式示例。
2. 选择一个场景继续：AI 聊天与流式输出、Nuxt SSR 或 文档站与 VitePress。
3. 根据 安装与可选依赖 只添加真正需要的 peer。

如果第一屏没有跑通，使用 按症状排查。跑通后再把 使用与 API 和 Props 与选项 当作参考，不需要从头读完所有页面。

我想做业务定制

• API 参考：解析器工具、作用域覆盖和渲染流程入口。
• 渲染器与节点组件：导出的渲染器和节点组件参考。
• 覆盖内置组件：替换 image、code_block、mermaid、link 等内置节点。
• 自定义标签与高级组件：支持 thinking 这类可信标签。
• YAML Front Matter Cookbook：提取页面 metadata，或先转换成可信自定义标签再渲染。
• 高级解析 与 解析器 API：需要 token / AST 级改造时再看。

我想接入到现有项目里

• Nuxt SSR：处理浏览器专属依赖和 ClientOnly。
• AI / Skills 工作流：复制即用的任务模板、skill 清单和迁移提示词。
• 从 react-markdown 迁移 与 迁移 Cookbook：适合 React 团队。
• 故障排除：安装能跑但样式、SSR 或 peers 出问题时先看。

框架入口

Vue 3 (markstream-vue) ⭐ 推荐

页面	描述
安装	只安装你真正需要的依赖组合
Vue 快速开始	渲染第一篇 Vue Markdown
使用与流式渲染	决定 content 与 nodes 的接入方式
文档站与 VitePress 集成	文档页、enhanceApp、可信标签与 CSS 顺序的一站式路径
AI 聊天与流式输出	适合聊天 UI、SSE 与逐 token 输出的场景路径
API 参考	解析器工具、作用域覆盖和渲染流程入口
渲染器与节点组件	渲染器和节点组件总览
自定义	覆盖内置组件与扩展自定义标签
YAML Front Matter	提取 metadata，或映射到可信自定义标签

Vue 2 (markstream-vue2)

页面	描述
安装	Vue 2 专用安装
快速开始	Vue 2 示例
组件与 API	Vue 2 组件参考

React (markstream-react)

页面	描述
安装	React 专用安装
快速开始	React 示例
React 组件	React 渲染器和节点组件
从 react-markdown 迁移	面向现有 React Markdown 项目的迁移路径
迁移 Cookbook	常见迁移场景的 before/after 示例

Angular (markstream-angular)

页面	描述
安装	Angular 专用安装
快速开始	standalone Angular 示例

Svelte (markstream-svelte)

页面	描述
快速开始	Svelte 5-only 渲染器、workers 与自定义组件示例

Nuxt

• Nuxt SSR 指南：处理客户端边界、workers 和浏览器专属 peers。