markstream-vue 1.0.3-beta.2 → 1.0.3-beta.3

package/README.md

@@ -1,8 +1,8 @@
 # Markstream
 
-> Streaming Markdown renderers for AI applications across Vue, React, Svelte, Angular, Nuxt, and Next.js.
+Markstream is a streaming Markdown renderer family for AI chat, LLM token streams, SSE/WebSocket output, and long AI responses.
 
-Markstream is built for Markdown that changes while users are watching it: LLM token streams, SSE/WebSocket output, AI chat messages, long documents, progressive Mermaid diagrams, KaTeX math, streaming code blocks, and safe component-based rendering.
+Use `markstream-vue` for Vue 3, Nuxt, and VitePress; use the sibling packages for React, Svelte, and Angular. The renderer is built for incomplete Markdown states, progressive Mermaid, KaTeX, streaming code blocks, mobile WebView, and safe component rendering.
 
 [![中文版](https://img.shields.io/badge/docs-中文文档-blue)](README.zh-CN.md)
 [![Docs](https://img.shields.io/badge/docs-vitepress-blue)](https://markstream.simonhe.me/)
@@ -29,6 +29,14 @@ Other packages:
 [![CI](https://github.com/Simon-He95/markstream-vue/actions/workflows/ci.yml/badge.svg)](https://github.com/Simon-He95/markstream-vue/actions/workflows/ci.yml)
 [![License](https://img.shields.io/npm/l/markstream-vue)](./license)
 
+## Why not marked / markdown-it / react-markdown?
+
+Use `marked`, `markdown-it`, or `react-markdown` for finished Markdown documents.
+
+Use Markstream when the Markdown is still changing while the user is reading it.
+
+Detailed comparisons: [react-markdown](https://markstream.simonhe.me/compare/react-markdown), [marked / markdown-it](https://markstream.simonhe.me/compare/marked-markdown-it), and [Streamdown](https://markstream.simonhe.me/compare/streamdown).
+
 ## Packages
 
 Start with the [framework overview](https://markstream.simonhe.me/frameworks) if you are choosing between packages.
@@ -72,6 +80,7 @@ For the full release contract and Go / No-Go checklist, see [1.0 Release Readine
 - [Streaming in 30 seconds](#-streaming-in-30-seconds)
 - [Performance presets](#-performance-presets)
 - [Key props & options](#-key-props--options-cheatsheet)
+- [Support the project](#support-the-project)
 - [Where it shines](#-where-it-shines)
 - [FAQ](#-faq-quick-answers)
 - [Why markstream-vue](#-why-markstream-vue-over-a-typical-markdown-renderer)
@@ -167,14 +176,6 @@ npx skills add git@github.com:Simon-He95/markstream-vue.git
 
 The test page gives you an editor + live preview plus “generate share link” that encodes the input in the URL (with a fallback to open directly or pre-fill a GitHub Issue for long payloads).
 
-## Support the project
-
-If markstream-vue helps your work, you can support ongoing maintenance with one of these QR codes.
-
-| Alipay | WeChat Pay |
-| --- | --- |
-| <img src="https://raw.githubusercontent.com/Simon-He95/markstream-vue/main/docs/public/sponsor/zhifubao.jpg" alt="Alipay QR code" width="240" /> | <img src="https://raw.githubusercontent.com/Simon-He95/markstream-vue/main/docs/public/sponsor/weixin.jpg" alt="WeChat Pay QR code" width="240" /> |
-
 ## ⚡ Quick Starts
 
 ### Vue / Nuxt
@@ -559,6 +560,14 @@ Parse hooks example (match server + client):
 />
 ```
 
+## Support the project
+
+If markstream-vue helps your work, you can support ongoing maintenance with one of these QR codes.
+
+| Alipay | WeChat Pay |
+| --- | --- |
+| <img src="https://raw.githubusercontent.com/Simon-He95/markstream-vue/main/docs/public/sponsor/zhifubao.jpg" alt="Alipay QR code" width="240" /> | <img src="https://raw.githubusercontent.com/Simon-He95/markstream-vue/main/docs/public/sponsor/weixin.jpg" alt="WeChat Pay QR code" width="240" /> |
+
 ## 🔥 Where it shines
 
 - AI/chat UIs with long-form answers and Markdown tokens arriving over SSE/websocket.

package/README.zh-CN.md

@@ -2,7 +2,9 @@
 
 > 面向 AI 应用的多框架流式 Markdown 渲染器家族 — 支持 Vue、React、Svelte、Angular、Nuxt 和 Next.js。
 
-Markstream 专为在用户眼前持续变化的 Markdown 场景而构建：LLM token 流、SSE/WebSocket 输出、AI 聊天消息、长文档、渐进式 Mermaid 图表、KaTeX 数学公式、流式代码块以及安全的组件化渲染。
+Markstream 专为在用户眼前持续变化的 Markdown 场景而构建：LLM token 流、SSE/WebSocket 输出、AI 聊天消息、未闭合 Markdown 中间态、长文档、渐进式 Mermaid 图表、KaTeX 数学公式、流式代码块以及安全的组件化渲染。
+
+Vue 3、Nuxt 和 VitePress 项目优先使用 `markstream-vue`；React、Svelte、Angular 项目使用对应 sibling package。普通 AI 聊天可以直接传不断累积的 `content` 字符串，只有外层已经负责解析、batch 或 worker AST 时才需要 `nodes` 路径。
 
 [![English](https://img.shields.io/badge/docs-English-blue)](README.md)
 [![Docs](https://img.shields.io/badge/docs-中文文档-blue)](https://markstream.simonhe.me/zh/guide)

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "markstream-vue",
   "type": "module",
-  "version": "1.0.3-beta.2",
-  "description": "Vue/Nuxt streaming Markdown renderer for AI chat, SSE/WebSocket output, mobile WebView, docs sites, long documents, and optional Mermaid, KaTeX, Shiki, Monaco.",
+  "version": "1.0.3-beta.3",
+  "description": "Vue/Nuxt streaming Markdown renderer for AI chat, LLM token streams, SSE/WebSocket output, incomplete Markdown, long documents, Mermaid, KaTeX, Shiki, and Monaco.",
   "author": "Simon He",
   "license": "MIT",
   "homepage": "https://markstream.simonhe.me/frameworks/vue",
@@ -17,19 +17,33 @@
     "markdown",
     "markdown-renderer",
     "streaming-markdown",
+    "streaming-markdown-renderer",
+    "markdown-streaming",
+    "ai-markdown-renderer",
     "ai-chat",
     "llm",
+    "llm-markdown",
+    "llm-streaming",
     "sse",
+    "sse-markdown",
     "websocket",
+    "websocket-markdown",
     "vue",
     "vue3",
     "nuxt",
     "vitepress",
     "vue-markdown",
+    "vue-streaming-markdown",
+    "nuxt-markdown",
+    "vitepress-markdown",
+    "incomplete-markdown",
     "mermaid",
+    "streaming-mermaid",
     "katex",
+    "streaming-katex",
     "shiki",
     "monaco-editor",
+    "streaming-code-blocks",
     "large-documents",
     "safe-html",
     "mobile-webview",