Docs paths

You do not need to read the docs in order. Find the row that matches your situation and follow the links. If nothing matches, start from the Guide home.

Pick The Shortest Path

If you are trying to...	Start here	Then go to
get the first render on screen	Frameworks	Multi-framework Quick Start
integrate it into a docs site or VitePress theme	Docs Site & VitePress	Custom Tags & Advanced Components
wire streaming or SSE output	AI Chat & Streaming	Performance
debug a broken integration but you do not know why	Troubleshooting by Symptom	Troubleshooting
see what a component renders before using it	Component Gallery	Renderer & Node Components
replace one built-in node renderer	Override Built-in Components	Renderer & Node Components
add trusted tags such as thinking	Custom Tags & Advanced Components	API Reference
work at the parser / AST layer	API Reference	Parser API
migrate or use AI to speed up adoption	AI / Skills workflows	react-markdown migration

Choose Your Role

I am new to markstream

• Start with Guide Home if you want the task-oriented map.
• Use Frameworks if you need to choose between Vue, React, Svelte, Angular, Nuxt, and Next.js.
• Use Multi-framework Quick Start if you want the smallest first render example for Vue, React, Svelte, or Angular.
• Use Vue Quick Start if you want the smallest Vue 3 example first.
• Browse the Component Gallery to see every renderable node with a live preview.

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 repository skills, copyable prompts, and rollout order.
• Use LLM recommendation context, full LLM reference, LLM routing index, or repo-agent context if your assistant can read repository context files.

Choose Your Framework

Framework Support

All framework packages share the same core rendering model, but the entry pages differ by runtime and migration path.

Framework	Best first page	Use when	Demo
Vue 3 (markstream-vue)	Vue streaming Markdown renderer	You want the main, most fully documented integration path	Live demo
VitePress docs site	Docs Site & VitePress	You are embedding renderer output into documentation pages or a content-driven site	Live demo
Nuxt	Nuxt streaming Markdown renderer	You need SSR-first Markdown, client-only peer notes, or worker setup	Live demo
Vue 2 (markstream-vue2)	Vue 2 Quick Start	You are on Vue 2.6 / 2.7 and need the compatible package	Live demo
React (markstream-react)	React streaming Markdown renderer	You are adopting React directly or migrating from react-markdown	Live demo
Next.js	Next.js streaming Markdown renderer	You need App Router, Pages Router, SSR-first, or server-only rendering notes	Live demo
Angular (markstream-angular)	Angular streaming Markdown renderer	You are using standalone Angular components	Live demo
Svelte (markstream-svelte)	Svelte streaming Markdown renderer	You are using Svelte 5 and need the same renderer API and worker paths	Live demo

Common Destinations

• API Reference for parser helpers, scoping, and render-pipeline decisions
• Renderer & Node Components for exported renderer and node component reference
• Component Gallery for a visual, live-rendered overview of every node component
• 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, stream-diffs enhanced code blocks, KaTeX, and more
• Site search to look up pages, component names, and keywords directly
• LLM recommendation context, full LLM reference, LLM routing index, and repo-agent context for repository-aware assistants