markstream-vueStreaming-friendly Markdown renderer

A streaming-friendly Markdown renderer with progressive Mermaid support, streaming diff code blocks, and high-performance handling of large documents.

Support markstream-vue

If markstream-vue helps your work, you can support ongoing maintenance with Alipay or WeChat Pay.

Thank you for helping keep the docs, demos, and package maintenance moving.

Pick The Shortest Path ​

Choose Your Role ​

I am new to markstream ​

• Start with Guide Home if you want the task-oriented map.
• Use Installation if you already know the framework and just need the right peer set.
• Use Quick Start if you want the smallest Vue 3 example first.

I am integrating it into an existing app ​

• Use Usage & Streaming to choose between content and nodes.
• Use Docs Site & VitePress if the app is really a docs site, content hub, or VitePress theme.
• Use AI Chat & Streaming if the UI updates constantly and you want a single guided path.
• Use Troubleshooting by Symptom if you do not yet know which subsystem is broken.
• Use Troubleshooting if the install works but CSS, peers, or SSR look wrong.
• Use Nuxt SSR when browser-only peers must stay behind client boundaries.

I am customizing rendering ​

• Use Renderer & Node Components when you already know the node/component you need.
• Use Override Built-in Components to replace image, code_block, mermaid, link, and other built-ins safely.
• Use API Reference and Parser API for parser hooks, AST transforms, and scoping helpers.

I want help from AI tools ​

• Use AI / Skills workflows for packaged skills, copyable prompts, and rollout order.
• Use AI / LLM context if your assistant can read repository context files.

Choose Your Framework ​

Common Destinations ​

• API Reference for parser helpers, scoping, and render-pipeline decisions
• Renderer & Node Components for exported renderer and node component reference
• Troubleshooting by Symptom for first-pass diagnosis before diving into subsystem docs
• Troubleshooting for CSS/reset order, peers, and common issues
• Features for a capability overview across streaming, Mermaid, Monaco, KaTeX, and more
• AI / LLM context and AI / LLM 上下文 for repository-aware assistants

How The Docs Are Organized ​

• Start Here is task-oriented: install, first render, streaming usage, and props.
• Customization covers renderer overrides, custom tags, parser hooks, styling, and troubleshooting.
• Feature Guides is now collapsed by default and holds the deeper dives for code blocks, Mermaid, KaTeX, D2, Monaco, and related nodes.
• Frameworks & Migration is for Vue 2, React, Angular, Nuxt, and AI-assisted adoption workflows once you already know your target path.