markstream-vue

v0.0.7-beta.9

Published

3 days ago

Vue 3 Markdown renderer optimized for large docs: progressive Mermaid, streaming diff code blocks, and fast real-time preview.

markstream-vue

针对 Vue 3 的高性能、流式友好型 Markdown 渲染组件 — 支持渐进式 Mermaid、流式 diff 代码块以及为大文档优化的实时预览。

需要其他框架/版本？

Vue 2.6：请使用 markstream-vue2（基础移植版，功能更精简）
React：请参考 packages/markstream-react 的说明 packages/markstream-react/README.md（初步移植版）

速览

为 流式 Markdown（AI/聊天/SSE）打造，避免闪烁，内存可预期。
双渲染模式：长文档虚拟化窗口，或“打字机”式增量批次。
渐进式图表（Mermaid）与 流式代码块（Monaco/Shiki），跟上 diff/增量输出。
同时支持 Markdown 字符串或预解析节点，可在 Markdown 中嵌入 自定义 Vue 组件。
TypeScript 优先，开箱默认即可上线（导入 CSS 即用）。

🚀 立即试用

Playground（交互演示）： https://markstream-vue.simonhe.me/
交互测试页（可分享链接，便于复现）： https://markstream-vue.simonhe.me/test
文档： https://markstream-vue-docs.simonhe.me/zh/guide/
AI/LLM 项目索引（中文）： https://markstream-vue-docs.simonhe.me/llms.zh-CN
AI/LLM 项目索引（英文）： https://markstream-vue-docs.simonhe.me/llms
一键 StackBlitz 体验： https://stackblitz.com/github/Simon-He95/markstream-vue?file=playground/src/App.vue
更新日志： CHANGELOG.md
Nuxt playground：pnpm play:nuxt
Discord： https://discord.gg/vkzdkjeRCW

💬 社区与支持

Discussions：https://github.com/Simon-He95/markstream-vue/discussions
Discord：https://discord.gg/vkzdkjeRCW
Issues：请使用模板并附上复现链接（https://markstream-vue.simonhe.me/test）

测试页内置编辑器 + 实时预览，并提供“生成分享链接”功能（过长内容会回退为直接打开或预填 GitHub Issue）。

⚡ 快速上手

pnpm add markstream-vue
# npm install markstream-vue
# yarn add markstream-vue

import MarkdownRender from 'markstream-vue'
// main.ts
import { createApp } from 'vue'
import 'markstream-vue/index.css'

createApp({
  components: { MarkdownRender },
  template: '<MarkdownRender custom-id="docs" :content="doc" />',
  setup() {
    const doc = '# Hello markstream-vue\\n\\n支持 **流式** 节点。'
    return { doc }
  },
}).mount('#app')

确保在 CSS reset（如 @tailwind base 或 @unocss/reset）之后导入 markstream-vue/index.css，最好放在 @layer components 中以避免 Tailwind/UnoCSS 覆盖组件样式。根据需求再按需安装可选 peer 依赖：stream-monaco（Monaco 代码块）、shiki + stream-markdown（Shiki 高亮）、mermaid（Mermaid 图表）、katex（数学公式）。

渲染器的 CSS 会作用于内部 .markstream-vue 容器下，以尽量降低对全局的影响；如果你脱离 MarkdownRender 单独使用导出的节点组件，请在外层包一层带 markstream-vue 类名的容器。

暗色变量可以通过给祖先节点加 .dark，或直接给 MarkdownRender 传入 :is-dark="true"（仅对渲染器生效）。

按需启用重型依赖：

import { enableKatex, enableMermaid } from 'markstream-vue'
import 'markstream-vue/index.css'
import 'katex/dist/katex.min.css'

// 安装对应 peer 后再启用
enableMermaid()
enableKatex()

如果你是用 CDN 引入 KaTeX，并且希望公式在 Web Worker 中渲染（不打包 / 不安装可选 peer），可以注入一个“CDN 加载 KaTeX”的 worker：

import { createKaTeXWorkerFromCDN, setKaTeXWorker } from 'markstream-vue'

const { worker } = createKaTeXWorkerFromCDN({
  mode: 'classic',
  // worker 内通过 importScripts() 加载的 UMD 构建
  katexUrl: 'https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js',
  mhchemUrl: 'https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/mhchem.min.js',
})

if (worker)
  setKaTeXWorker(worker)

如果你是用 CDN 引入 Mermaid，并且希望 Mermaid 的解析在 worker 中进行（用于渐进式 Mermaid 渲染的后台解析），可以注入 Mermaid parser worker：

import { createMermaidWorkerFromCDN, setMermaidWorker } from 'markstream-vue'

const { worker } = createMermaidWorkerFromCDN({
  // Mermaid CDN 构建通常是 ESM，推荐 module worker。
  mode: 'module',
  workerOptions: { type: 'module' },
  mermaidUrl: 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs',
})

if (worker)
  setMermaidWorker(worker)

// plugins/markstream-vue.client.ts
import { defineNuxtPlugin } from '#app'
import MarkdownRender from 'markstream-vue'
import 'markstream-vue/index.css'

export default defineNuxtPlugin((nuxtApp) => {
  nuxtApp.vueApp.component('MarkdownRender', MarkdownRender)
})

然后在页面中直接使用 <MarkdownRender :content=\"md\" />。

🛠️ 常用命令

pnpm dev — playground 开发
pnpm play:nuxt — Nuxt playground 开发
pnpm build — 构建库与 CSS
pnpm test — Vitest 测试（快照用 pnpm test:update）
pnpm typecheck / pnpm lint — 类型检查与 Lint

⏱️ 30 秒流式接入

用 SSE / WebSocket 增量渲染 Markdown：

import type { ParsedNode } from 'markstream-vue'
import MarkdownRender, { getMarkdown, parseMarkdownToStructure } from 'markstream-vue'
import { ref } from 'vue'

const nodes = ref<ParsedNode[]>([])
const buffer = ref('')
const md = getMarkdown()

function addChunk(chunk: string) {
  buffer.value += chunk
  nodes.value = parseMarkdownToStructure(buffer.value, md)
}

// 例如在 SSE / onmessage 处理器中
eventSource.onmessage = event => addChunk(event.data)

// template
// <MarkdownRender
//   :nodes="nodes"
//   :max-live-nodes="0"
//   :batch-rendering="{
//     renderBatchSize: 16,
//     renderBatchDelay: 8,
//   }"
// />

按页面需要切换渲染风格：

虚拟化窗口（默认）：长文档滚动平稳、内存稳定。
增量批次：将 :max-live-nodes="0"，获得更明显的“打字机”体验与轻量占位。

SSR / Worker（确定性输出）

在服务端或 Worker 预解析 Markdown，前端直接渲染节点：

// server or worker
import { getMarkdown, parseMarkdownToStructure } from 'markstream-vue'

const md = getMarkdown()
const nodes = parseMarkdownToStructure('# Hello\n\n服务端解析一次', md)
// 将 nodes JSON 下发到客户端

<!-- client -->
<MarkdownRender :nodes="nodesFromServer" />

这样可以避免前端解析，保持 SSR/水合的一致性。

混合模式：SSR + 流式续写

服务端：解析首批 Markdown，序列化 initialNodes（以及 initialMarkdown，便于后续流式追加）。
客户端：用相同的解析配置水合，然后继续流式追加：

import type { ParsedNode } from 'markstream-vue'
import { getMarkdown, parseMarkdownToStructure } from 'markstream-vue'
import { ref } from 'vue'

const nodes = ref<ParsedNode[]>(initialNodes)
const buffer = ref(initialMarkdown)
const md = getMarkdown() // 与服务端保持一致

function addChunk(chunk: string) {
  buffer.value += chunk
  nodes.value = parseMarkdownToStructure(buffer.value, md)
}

这样无需重新解析 SSR 内容，同时还能通过 SSE/WebSocket 持续追加后续片段。

提示：当你明确知道流已结束（消息已完整）时，建议用 parseMarkdownToStructure(buffer.value, md, { final: true }) 或在组件上设置 :final="true"，以关闭解析器的中间态（loading）策略，避免末尾残留分隔符（如 $$、未闭合 code fence）导致永久 loading。

⚙️ 性能模式

默认虚拟化窗口：保持 max-live-nodes 默认值（320），渲染器会立即渲染当前窗口的节点，同时只保留有限数量的 DOM 节点，实现平滑滚动与可控内存，占位骨架极少。
增量流式模式：当需要更明显的“打字机”体验时，将 :max-live-nodes="0"。这会关闭虚拟化并启用 batchRendering 系列参数控制的增量渲染，新的节点会以小批次加上占位骨架的形式进入视图。

可根据页面类型选择最合适的模式：虚拟化适合长文档/回溯需求，增量流式适合聊天或 AI 输出面板。

小贴士：聊天场景可使用 max-live-nodes="0"，并将 renderBatchSize 调小（如 16），renderBatchDelay 设为较小值（如 8ms），获得平滑的“打字”节奏且避免大段跳变。如需限制单帧 CPU，可适当调低 renderBatchBudgetMs。

🧰 关键属性速览

content 与 nodes：传原始 Markdown 或预解析节点（来自 parseMarkdownToStructure）。
max-live-nodes：320（默认虚拟化）或 0（增量批次）。
batchRendering：用 initialRenderBatchSize、renderBatchSize、renderBatchDelay、renderBatchBudgetMs 微调批次。
enableMermaid / enableKatex：用于（重新）启用重型依赖或自定义 loader（可与 disableMermaid / disableKatex 配合）。
parse-options：在组件上复用解析钩子（如 preTransformTokens、requireClosingStrong）。
final：标记“最终态/流结束”，关闭中间态 loading 解析并强制收敛未闭合结构。
custom-html-tags：扩展流式 HTML 白名单并将这些标签输出为自定义节点，便于 setCustomComponents 直接映射（如 ['thinking']）。
setCustomComponents(customId?, mapping)：为自定义标签/标记注册内嵌 Vue 组件（传 custom-id 可限定作用域）。

示例：将 Markdown 占位符映射到 Vue 组件（作用域）

import { setCustomComponents } from 'markstream-vue'

setCustomComponents('docs', {
  CALLOUT: () => import('./components/Callout.vue'),
})

// Markdown: [[CALLOUT:warning title="提示" body="具体内容"]]

渲染时使用同一个 custom-id：

<MarkdownRender
  :content="doc"
  custom-id="docs"
/>

解析钩子示例（服务端/客户端保持一致）：

<MarkdownRender
  :content="doc"
  :parse-options="{
    requireClosingStrong: true,
    preTransformTokens: (tokens) => tokens,
  }"
/>

🔥 适用场景

AI / 聊天界面：Markdown token 通过 SSE/WebSocket 持续抵达，要求无闪烁与稳定内存。
文档、变更日志、知识库：需要即时加载，同时保持长内容滚动的流畅性。
流式 diff / 代码审查：Monaco 增量更新让大代码块也能跟上变更。
图表与示意：Mermaid 渐进式渲染，避免阻塞主渲染。
Markdown 驱动的界面中嵌入 Vue 组件（callout、交互式挂件、CTA 等）。

❓ 快问快答

Mermaid / KaTeX 不显示？安装对应 peer（mermaid / katex），并传入 :enable-mermaid="true" / :enable-katex="true" 或调用 loader 设置函数。如果你是用 CDN <script> 引入，库也会自动读取 window.mermaid / window.katex。
CDN + KaTeX worker：如果你不打包 katex 但仍希望公式在 worker 中渲染（不占主线程），可以用 createKaTeXWorkerFromCDN() 创建一个“CDN 加载 KaTeX”的 worker，然后通过 setKaTeXWorker() 注入。
体积问题：可选 peer 不会被打包，CSS 只需导入一次；对代码块可用 Shiki（MarkdownCodeBlockNode）替代 Monaco 以减轻体积。
自定义 UI：通过 setCustomComponents（全局或作用域）注册组件，在 Markdown 中放置占位标记并映射到 Vue 组件。

🆚 为什么选择 markstream-vue，而不是普通 Markdown 渲染器？

| 需求 | 普通 Markdown 预览 | markstream-vue | | --- | --- | --- | | 流式输入 | 全量重渲染、易闪烁 | 虚拟窗口 + 增量批次 | | 大代码块 | 重新高亮速度慢 | Monaco 流式更新 + 可选 Shiki | | 图表 | 解析/渲染阻塞 | Mermaid 渐进式渲染与回退 | | 自定义 UI | 插槽有限 | Markdown 内嵌 Vue 组件与类型化节点 | | 长文档 | 内存峰值高 | 可配置 live-node 上限，滚动稳定 |

🗺️ Roadmap（快照）

更多「即开即用」模板（Vite / Nuxt / Tailwind）与 StackBlitz 更新。
代码块预设扩展（适合 diff 的 Shiki 主题、Monaco 装饰/标注辅助）。
AI / 聊天场景的 Cookbook（SSE/WebSocket、重试与续传、Markdown 中间态处理）。
展示更多在 Markdown 中嵌入 Vue 组件的示例与实践。

📦 发布

最新版本与升级提示：Releases
完整历史：CHANGELOG.md
最新亮点（0.0.3-beta.1/beta.0）：
- 解析器升级到 [email protected]，修复多项解析问题。
- Monaco 升级，更多语言/主题，代码块对 diff 更友好。
- Playground 增加 HTML/SVG 预览对话框与 AST 调试视图。

🧭 案例与展示

用 markstream-vue 做了什么？欢迎提 PR 把你的项目放到这里（附链接 + 截图/GIF）。理想场景：AI/聊天界面、流式文档、diff/代码审查、或在 Markdown 驱动页面中嵌入 Vue 组件。

FlowNote —— 流式 Markdown 笔记示例（SSE + 虚拟化窗口）：https://markstream-vue.simonhe.me/
AI Chat 场景 —— playground “test” 页展示增量批次与分享链接：https://markstream-vue.simonhe.me/test

介绍视频

一段短视频介绍了 markstream-vue 的关键特性与使用方式。

在 Bilibili 上观看： Open in Bilibili

核心特性

⚡ 极致性能：为流式场景设计的最小化重渲染和高效 DOM 更新
🌊 流式优先：原生支持不完整或频繁更新的 token 化 Markdown 内容
🧠 Monaco 流式更新：高性能的 Monaco 集成，支持大代码块的平滑增量更新
🪄 渐进式 Mermaid：图表在语法可用时即时渲染，并在后续更新中完善
🧩 自定义组件：允许在 Markdown 内容中嵌入自定义 Vue 组件
📝 完整 Markdown 支持：表格、公式、Emoji、复选框、代码块等
🔄 实时更新：支持增量内容而不破坏格式
📦 TypeScript 优先：提供完善的类型定义与智能提示
🔌 零配置：开箱即可在 Vue 3 项目中使用
🎨 灵活的代码块渲染：可选 Monaco 编辑器 (CodeBlockNode) 或轻量的 Shiki 高亮 (MarkdownCodeBlockNode)
🧰 解析工具集：stream-markdown-parser 文档现已覆盖如何在 Worker/SSE 流中复用解析器、直接向 <MarkdownRender :nodes> 输送 AST、以及注册全局插件/数学辅助函数的方式。

🙌 贡献与社区

阅读贡献指南与 PR 模板：CONTRIBUTING.md
遵守行为准则。
提交 Issue 时使用模板；渲染问题尽量附上测试页复现链接：https://markstream-vue.simonhe.me/test
有问题先讨论：https://github.com/Simon-He95/markstream-vue/discussions
实时交流：Discord https://discord.gg/vkzdkjeRCW
新手贡献入口：good first issues
支持与求助入口：SUPPORT.md
提交 PR 时遵循 Conventional Commits，渲染/解析改动补充测试，UI 改动附上截图/GIF。
如果本项目对你有帮助，欢迎点 Star、分享给需要的人，助力项目持续演进。
安全披露：请通过 SECURITY.md 中的邮件私下报告潜在漏洞。

快速参与的方式

在现有 issue 中补充复现链接/截图。
完善文档或示例（尤其是流式 + SSR/Worker 场景）。
分享 playground/test 链接，展示性能边界或有趣用法。

故障排查 & 常见问题

详细故障排查与常见问题已迁移至文档站点： https://markstream-vue-docs.simonhe.me/zh/guide/troubleshooting

如需更多帮助，请到 GitHub Issues 创建问题： https://github.com/Simon-He95/markstream-vue/issues

快速提交问题

在测试页复现并点击“生成分享链接”：https://markstream-vue.simonhe.me/test
打开 Bug 模板并附上链接与截图：https://github.com/Simon-He95/markstream-vue/issues/new?template=bug_report.yml

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

markstream-vue

目录

速览

🚀 立即试用

💬 社区与支持

⚡ 快速上手

🛠️ 常用命令

⏱️ 30 秒流式接入

SSR / Worker（确定性输出）

混合模式：SSR + 流式续写

⚙️ 性能模式

🧰 关键属性速览

🔥 适用场景

❓ 快问快答

🆚 为什么选择 markstream-vue，而不是普通 Markdown 渲染器？

🗺️ Roadmap（快照）

📦 发布

🧭 案例与展示

介绍视频

核心特性

🙌 贡献与社区

快速参与的方式

故障排查 & 常见问题

快速提交问题

鸣谢

贡献者

依赖项目

Star 历史

许可