Practical overview
When it fits
Use Markstream Vue when a Vue-based interface must render Markdown during a live response or other incremental update. The project distinguishes this use from rendering finished Markdown documents.
Who it is for
- Developers building AI chat interfaces with Vue 3.
- Teams using Nuxt or VitePress that need to render Markdown while content is still arriving.
- Developers choosing a framework-specific renderer from the Markstream family.
Documented uses
- Display an AI response as Markdown while its content is still changing.
- Show streamed code blocks, Mermaid diagrams and KaTeX equations in a response.
- Render Markdown in a Vue interface and pass a completion state to the renderer.
Requirements & limits
The repository declares an MIT license.
- The Vue package targets Vue 3, Nuxt and VitePress; other listed frameworks have separate packages.
- Mermaid, KaTeX and stream-diffs are optional peers, needed only for their associated enhancements.
- The project recommends
htmlPolicy="escape"for untrusted user-generated content. - The project says completed Markdown documents can be handled with finished-document renderers; Markstream is intended for content that changes while being read.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Add the renderer to a Vue application
Install Markstream Vue and display Markdown content with its component.
Before you start
- A Vue 3, Nuxt or VitePress application
- pnpm package manager
Steps
Install the package with
pnpm add markstream-vue.Import
MarkdownRenderfrommarkstream-vueand importmarkstream-vue/index.css.Render `` with the Markdown string supplied by the application.
Expected outcome
The application displays the supplied Markdown through the Markstream Vue component.
Guide limitations
- Mermaid, KaTeX and stream-diffs are optional peers for diagrams, math, and enhanced code or diff blocks.
Configure a Vue chat message for streamed content
Pass changing message content and completion state to the renderer in chat mode.
Before you start
- A Vue 3 application with
markstream-vueinstalled - A message string and a boolean indicating whether generation is complete
Steps
Import
MarkdownRenderandmarkstream-vue/index.css.Pass the current message as
contentand its completion state asfinal.Set
mode="chat"for the chat surface.
Expected outcome
The renderer receives the evolving message and whether the response is complete, using chat mode.
Guide limitations
- The documented component setup does not provide an AI model, transport, or message-generation service.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- Simon-He95/markstream-vue · Official homepage title · retained in its source language

