# QuireKit Markdown 开发者文档

基于 Lezer 的公共 Markdown 内核、增量流式更新与 Vue/React 渲染。公开包为 @quirekit/incremark-core、@quirekit/incremark 和 @quirekit/incremark-react，当前为工作区预览版。

[English](/en/llms.txt)

- [文档总览](/raw/index.md): 从普通正文到 AI 流式回答，用同一个解析与渲染入口。
- [快速开始](/raw/guide/getting-started.md): 在 Vue 页面显示第一段 Markdown，理解正文、主题和保存的分工。
- [Playground](/raw/playground.md): 编辑源码、切换样例，观察同一份 Markdown 的完整加载与流式更新。
- [语法与支持范围](/raw/guide/syntax.md): 区分默认语法、显式配置与需要宿主接入的能力。
- [AI 流式接入](/raw/guide/streaming.md): 把陆续收到的 Markdown 显示为同一条消息，并处理结束、取消与失败。
- [React 接入](/raw/guide/react.md): React 组件、流式更新、SSR 和自定义节点，与 Vue 共用解析内核。
- [无框架解析](/raw/guide/headless.md): 不创建阅读组件，直接把 Markdown 解析为文本与语法树。
- [组件库与编辑器集成](/raw/guide/integration.md): 选择独立阅读组件，或沿用 MdProse 的编辑器产品能力。
- [替换渲染组件](/raw/guide/components.md): 替换链接、图片或代码块的外观，同时保留原有 Markdown 解析。
- [自定义语法与节点](/raw/guide/extensions.md): 为业务语法增加解析和阅读显示，以待办状态标记为例。
- [流程图、思维导图与白板](/raw/guide/diagrams.md): 用现有编辑器的图稿渲染文档，并在 Markdown 阅读组件中接入同样的能力。
- [HTML 与内联样式](/raw/guide/html.md): 显示 Markdown 中的 HTML，按需限制标签、地址和内联样式。
- [与 Incremark 比较](/raw/guide/comparison.md): 为什么我们重新设计了 Incremark，以及新引擎怎样处理流式 Markdown。
- [增量渲染与性能](/raw/guide/performance.md): 了解默认缓存、声明自定义依赖，以及如何测量实际更新成本。
- [解析 API](/raw/api/core.md): 从公开 TypeScript 导出生成的签名与逐项说明。
- [Vue 与扩展 API](/raw/api/vue.md): 从公开 TypeScript 导出生成的签名与逐项说明。
- [React API](/raw/api/react.md): React 组件、hook 与扩展的真实公开类型。