Guide
For Vue 3 and Nuxt, follow the three-step path below. If you use another framework, choose its package from Frameworks first.
Get Vue Working
- Vue Quick Start — install, import CSS, and copy a complete static or streaming example.
- Choose one scenario: AI Chat & Streaming, Nuxt SSR, or Docs Site & VitePress.
- Add only the optional peers you need from Installation.
If the first render fails, use Troubleshooting by Symptom. Once it works, use Usage & API and Props & Options as reference rather than reading every page in order.
I Want To Customize Rendering
- API Reference for parser helpers, scoping, and render-pipeline entry points.
- Renderer & Node Components for exported renderer and node component reference.
- Override Built-in Components to replace
image,code_block,mermaid,link, or other built-ins. - Custom Tags & Advanced Components to support trusted tags such as
thinking. - YAML Front Matter Cookbook to extract page metadata or convert it into a trusted custom tag.
- Advanced Parser Hooks and Parser API for token or AST-level customization.
I Want To Adopt It In An Existing App
- Nuxt SSR for browser-only peers and client-only guards.
- AI / Skills workflows for copyable prompts, reusable checklists, and migration tasks.
- Migrate from react-markdown and the Migration Cookbook for React teams.
- Troubleshooting when the install works but styles, peers, or SSR do not.
Framework Entry Points
Vue 3 / Nuxt (markstream-vue) — most mature renderer
| Page | Description |
|---|---|
| Installation | Install the package and only the peers you actually need |
| Vue Quick Start | Render your first Vue Markdown document |
| Usage & Streaming | Decide between content and nodes |
| Docs Site & VitePress | Guided path for docs pages, enhanceApp, trusted tags, and CSS order |
| AI Chat & Streaming | Guided path for chat UIs, SSE, and token-by-token output |
| API Reference | Parser helpers, scoping, and render-pipeline entry points |
| Renderer & Node Components | Renderer and node component reference |
| Customization | Override built-ins and add custom tags |
| YAML Front Matter | Extract metadata before rendering or map it to a trusted custom tag |
Vue 2 (markstream-vue2)
| Page | Description |
|---|---|
| Installation | Vue 2 specific setup |
| Quick Start | Vue 2 examples |
| Components & API | Vue 2 component reference |
React (markstream-react)
| Page | Description |
|---|---|
| Installation | React specific setup |
| Quick Start | React examples |
| React Components | React renderer and node components |
| Migrate from react-markdown | Migration path for existing React Markdown apps |
| Migration Cookbook | Before/after recipes for common migration scenarios |
Angular (markstream-angular)
| Page | Description |
|---|---|
| Installation | Angular specific setup |
| Quick Start | Standalone Angular examples |
Svelte (markstream-svelte)
| Page | Description |
|---|---|
| Quick Start | Svelte 5-only renderer usage, workers, and custom components |
Nuxt
- Nuxt SSR Guide for client-only boundaries, workers, and browser-only peers.