按任务查找
按下面的任务找到对应指南。首次接入时，先看安装与选择框架。框架专用指南标注了 React、Vue 或 Mantine，共享解析指南适用于三者。
| 应用程序 | 首次渲染 | 下一步任务 | 参考文档 |
|---|---|---|---|
| React | React 快速开始 | 流式对话、自定义组件 | React 组件 |
| Vue | Vue 快速开始 | 流式渲染、自定义渲染 | Vue API |
| React 与 Mantine | Mantine 快速开始 | 代码块与图表 | Mantine API |
| 框架适配器开发者 | 开发框架适配器 | Core 与 Engine 契约 | Core、Engine |
完成首次渲染后，配置渲染说明该调整哪一层：React 与 Vue 共享的解析选项，还是各适配器不同的组件与样式 API。
| 任务 | 指南 | 适用范围 |
|---|---|---|
| 理解累积输入、完成与取消机制 | 流式输入 | 全部 |
| 构建随 token 到达即时渲染的对话视图 | React 流式聊天 | React |
| 平滑处理突发到达的 token | React 平滑流式输出 | React |
| 在流式边缘显示光标 | React 流式光标 | React |
| 在 Vue 组件中流式渲染 | Vue 流式渲染 | Vue |
| 将逻辑文档拆分为共享引用的多个片段 | 文档与引用 | 全部 |
| 在 React 片段之间协调脚注与链接 | React 文档与引用协调 | React |
| 在 Vue 片段之间协调脚注与链接 | Vue 文档与引用 | Vue |
| 任务 | 指南 | 适用范围 |
|---|---|---|
| 添加代码块、Mermaid、图片预览与表格导出 | 增强 Markdown 组件 | React、Vue、Mantine |
| 选择需要调整的配置层 | 配置渲染 | 全部 |
| 确认支持渲染的 Markdown 语法 | Markdown 语法支持 | 全部 |
| 渲染中日韩与混合语言文本 | CJK 排版 | 全部 |
| 在解析前转换源文本 | 内容预处理器 | 全部 |
| 配置 URL 与 HTML 安全策略 | URL 过滤与安全策略 | 全部 |
| 用自己的组件替换渲染出的元素 | React 自定义组件 | React |
| 替换排版容器 | React 自定义排版容器 | React |
| 通过 CSS 变量调整间距、颜色与字体 | React CSS 设计变量 | React |
| 在 Vue 中自定义渲染与样式 | Vue 自定义渲染与样式定制 | Vue |
| 在浏览器中试用自己的 Markdown | 交互示例与 Playground | 全部 |
| 任务 | 指南 | 适用范围 |
|---|---|---|
| 用 Mantine 渲染代码块与图表 | Mantine 代码块与图表 | Mantine |
| 服务端渲染与水合 | React SSR 与水合 | React |
| 服务端渲染与组件生命周期管理 | Vue SSR 与生命周期 | Vue |
| 理解增量解析节省的开销 | 渲染与性能 | 全部 |
| 在流式输出时保持低成本重渲染 | React 流式传输与性能优化 | React |
API 参考
Section titled “API 参考”| 需求 | 页面 |
|---|---|
| 全部 React 属性及其默认值 | React 属性参考 |
| Hook 与 Provider | React Hooks 与 Provider |
| 传递给自定义组件的元数据 | React 元数据上下文 |
| 泛型组件与属性类型 | React TypeScript 泛型 |
| Vue 属性、插槽与导出 | Vue API |
| Mantine 属性与配置 | Mantine API |
| 次版本更新下哪些内容保持稳定 | API 规范与稳定性 |
故障排查与升级
Section titled “故障排查与升级”| 任务 | 指南 |
|---|---|
| 排查跨适配器的故障现象 | 故障排查 |
| 从旧包名升级 | 包名迁移 |
| 将 1.x 安装升级到 2.0 | 从 1.x 迁移到 2.0 |
| 查看各版本的更新记录 | 版本更新亮点 |
| 决定在测试中锁定或断言哪些内容 | 稳定性策略 |
1.x 到 2.x 迁移页面与 2026 年 7 月基准测试描述的是其对应版本的情况，不代表当下的安装要求。
| 任务 | 指南 |
|---|---|
| 开发框架适配器 | 开发框架适配器 |
| 依赖共享包 | Core 与 Engine 契约 |
| 发布 React 设计系统集成包 | 构建 React 集成包 |
| 阅读各包 API | Core、Engine、高亮插件、代码语言探测器 |
| 任务 | 指南 |
|---|---|
| 运行检查、测试与构建 | 开发命令 |
| 了解各包分别负责哪些文件 | 架构设计全景 |
| 编辑或部署本站点 | 文档站点 |
| 开发 Storybook 示例 | 交互式示例 |
| 测量一项改动 | 基准测试方法 |
| 验证核心契约与状态序列 | 核心测试 |
| 判断改动是否需要压测 | 压测覆盖映射 |
| 发布版本 | 版本发布指南 |
| 保持指南与实现同步 | 结合源码实现阅读指南 |
发布维护：已发布产物验证。3.0 版本发布验收记录是该版本的归档记录。
已迁移的章节
Section titled “已迁移的章节”以下章节原本位于本页，内容未作改动。
本指南遵循的规范现位于指南中的约定。
文档问题反馈现位于文档问题反馈。
结合源码实现阅读指南现位于结合源码实现阅读指南。