文档路径
你不需要按顺序读完文档。找到匹配你处境的那一行，顺着链接走即可。如果都对不上，从指南首页开始。
先走最短路径
| 如果你现在想解决的是... | 先看这里 | 然后看 |
|---|---|---|
| 把第一段渲染跑起来 | 框架选择 | 多框架快速开始 |
| 接到文档站或 VitePress 主题里 | 文档站与 VitePress 集成 | 自定义标签与高级组件 |
| 接入流式输出 / SSE | AI 聊天与流式输出 | 性能 |
| 接入坏了但还不知道是哪一层出问题 | 按症状排查 | 排查问题 |
| 先看看某个组件渲染出来什么样 | 组件画廊 | 渲染器与节点组件 |
| 替换一个内置节点渲染器 | 覆盖内置组件 | 渲染器与节点组件 |
支持 thinking 这类可信标签 | 自定义标签与高级组件 | API 参考 |
| 做 parser / AST 级改造 | API 参考 | 解析器 API |
| 借助 AI 做接入、迁移或排障 | AI / Skills 工作流 | 从 react-markdown 迁移 |
按你的角色选入口
我是第一次接触 markstream
- 先看 指南首页，它是按任务组织的总入口。
- 如果你还在 Vue、React、Svelte、Angular、Nuxt 和 Next.js 之间选择，先看 框架选择。
- 如果你想先看到各框架最小示例，直接看 多框架快速开始。
- 如果你想先看到最小 Vue 3 示例，直接看 Vue 快速开始。
- 想知道能渲染什么，逛逛 组件画廊，每个节点都有实时预览。
我是在现有项目里接入
- 用 使用与流式渲染 决定该走
content还是nodes。 - 如果本质上是在做文档站、内容站或 VitePress 主题，优先走 文档站与 VitePress 集成。
- 如果页面会持续更新，优先走 AI 聊天与流式输出 这条完整路径。
- 如果你还不知道到底是 CSS、peers、SSR 还是自定义标签的问题，先走 按症状排查。
- 如果安装能跑但页面效果不对，先看 故障排除。
- 如果是 Nuxt / SSR，优先看 Nuxt SSR。
我是在做业务定制
我想借助 AI 提高效率
- 看 AI / Skills 工作流，里面有 skills、prompts 和推荐接入顺序。
- 如果你用的是可读仓库的助手，再配合 LLM 推荐上下文、完整 LLM 参考、LLM 路由索引（英文）或 仓库 agent 上下文。
选择你的框架
框架支持
各框架共享同一套核心渲染思路，但入口页会因为 SSR、迁移路径和运行时差异而不同。
| 框架 | 最适合先看的页面 | 适合什么情况 | 演示 |
|---|---|---|---|
Vue 3 (markstream-vue) | Vue 流式 Markdown 渲染器 | 你要走主线能力最完整的接入路径 | 在线演示 |
| VitePress 文档站 | 文档站与 VitePress 集成 | 你要把渲染器嵌进文档页、内容站或自定义主题 | 在线演示 |
| Nuxt | Nuxt 流式 Markdown 渲染器 | 你需要处理 client-only 边界、SSR 和 worker | 在线演示 |
Vue 2 (markstream-vue2) | Vue 2 快速开始 | 你还在 Vue 2.6 / 2.7 环境 | 在线演示 |
React (markstream-react) | React 流式 Markdown 渲染器 | 你是 React 用户，或正从 react-markdown 迁移 | 在线演示 |
| Next.js | Next.js 流式 Markdown 渲染器 | 你需要 App Router、Pages Router、SSR-first 或 server-only 渲染说明 | 在线演示 |
Angular (markstream-angular) | Angular 流式 Markdown 渲染器 | 你使用 standalone Angular 组件 | 在线演示 |
Svelte (markstream-svelte) | Svelte 流式 Markdown 渲染器 | 你使用 Svelte 5，并希望复用一致的渲染 API 和 worker 路径 | 在线演示 |