markstream-vue 1.0.5-beta.1 → 1.0.5-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +27 -5
  2. package/README.zh-CN.md +1 -1
  3. package/dist/exports.js +1 -1
  4. package/dist/index.css +1 -1
  5. package/dist/index.px.css +1 -1
  6. package/dist/index.tailwind.css +1 -1
  7. package/dist/tailwind.js +0 -0
  8. package/package.json +6 -5
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # Markstream
1
+ # Markstream — Streaming Markdown renderers for AI chat
2
2
 
3
- Markstream is a streaming Markdown renderer family for AI chat, LLM token streams, SSE/WebSocket output, and long AI responses.
3
+ `markstream-vue` is a Vue 3 / Nuxt / VitePress streaming Markdown renderer for AI chat, LLM token streams, SSE/WebSocket output, incomplete Markdown, long AI responses, Mermaid, KaTeX, and streaming code blocks.
4
4
 
5
- Use `markstream-vue` for Vue 3, Nuxt, and VitePress; use the sibling packages for React, Svelte, Angular, and Vue 2. The renderer is built for incomplete Markdown states, progressive Mermaid, KaTeX, streaming code blocks, mobile WebView, and safe component rendering.
5
+ Markstream is the renderer family for Vue, React, Svelte, Angular, and Vue 2. Use sibling packages for non-Vue frameworks; use `markstream-vue` when your Vue/Nuxt/VitePress UI needs stable partial Markdown states, mobile WebView rendering, safe component rendering, and progressive heavy blocks.
6
6
 
7
7
  [![中文版](https://img.shields.io/badge/docs-中文文档-blue)](README.zh-CN.md)
8
8
  [![Docs](https://img.shields.io/badge/docs-vitepress-blue)](https://markstream.simonhe.me/)
@@ -30,13 +30,35 @@ Other packages:
30
30
  [![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)
31
31
  [![License](https://img.shields.io/npm/l/markstream-vue)](./license)
32
32
 
33
+ ## Install markstream-vue
34
+
35
+ ```bash
36
+ pnpm add markstream-vue
37
+ ```
38
+
39
+ ```vue
40
+ <script setup lang="ts">
41
+ import MarkdownRender from 'markstream-vue'
42
+ import 'markstream-vue/index.css'
43
+
44
+ defineProps<{
45
+ content: string
46
+ isDone: boolean
47
+ }>()
48
+ </script>
49
+
50
+ <template>
51
+ <MarkdownRender mode="chat" :content="content" :final="isDone" />
52
+ </template>
53
+ ```
54
+
33
55
  ## Why not marked / markdown-it / react-markdown?
34
56
 
35
57
  Use `marked`, `markdown-it`, or `react-markdown` for finished Markdown documents.
36
58
 
37
59
  Use Markstream when the Markdown is still changing while the user is reading it.
38
60
 
39
- 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).
61
+ Detailed comparisons: [vue-stream-markdown](https://markstream.simonhe.me/compare/vue-stream-markdown), [Streamdown](https://markstream.simonhe.me/compare/streamdown), [react-markdown](https://markstream.simonhe.me/compare/react-markdown), and [marked / markdown-it](https://markstream.simonhe.me/compare/marked-markdown-it).
40
62
 
41
63
  ## Packages
42
64
 
@@ -64,7 +86,7 @@ Start with the [framework overview](https://markstream.simonhe.me/frameworks) if
64
86
 
65
87
  ## Stability
66
88
 
67
- `markstream-vue@1.0` is the most mature renderer with a stable surface: `MarkdownRender`, streaming content rendering, pre-parsed node rendering, the safe HTML policy, optional Mermaid / KaTeX / Monaco / D2 / Infographic integrations, virtual-scroll coordination, CSS exports, worker client subpaths, and SSR imports for Vite / Nuxt / VitePress.
89
+ `markstream-vue` has a stable 1.x API contract. The current npm package may still use beta tags while the 1.0 release gate and cross-framework package family are finalized. The stable surface includes `MarkdownRender`, streaming content rendering, pre-parsed node rendering, the safe HTML policy, optional Mermaid / KaTeX / Monaco / D2 / Infographic integrations, virtual-scroll coordination, CSS exports, worker client subpaths, and SSR imports for Vite / Nuxt / VitePress.
68
90
 
69
91
  Cross-framework renderers (`markstream-react`, `markstream-svelte`, `markstream-angular`, `markstream-vue2`) are available and actively developed. Check each package page for API maturity, framework support, and known limitations.
70
92
 
package/README.zh-CN.md CHANGED
@@ -58,7 +58,7 @@ Vue 包：
58
58
 
59
59
  ## 稳定性
60
60
 
61
- `markstream-vue@1.0` 是最成熟的渲染器，稳定面包括：`MarkdownRender`、流式内容渲染、预解析节点渲染、安全 HTML 策略、可选 Mermaid / KaTeX / Monaco / D2 / Infographic 集成、虚拟滚动协调、CSS 导出、worker client 子路径以及 Vite / Nuxt / VitePress 的 SSR 导入。
61
+ `markstream-vue` 已进入稳定的 1.x API 契约；当前 npm 包仍可能带 beta tag，用于发布门禁和跨框架家族同步。稳定面包括：`MarkdownRender`、流式内容渲染、预解析节点渲染、安全 HTML 策略、可选 Mermaid / KaTeX / Monaco / D2 / Infographic 集成、虚拟滚动协调、CSS 导出、worker client 子路径以及 Vite / Nuxt / VitePress 的 SSR 导入。
62
62
 
63
63
  跨框架渲染器（`markstream-react`、`markstream-svelte`、`markstream-angular`、`markstream-vue2`）已可用并积极开发中。请查看各包文档了解 API 成熟度、框架支持和已知限制。
64
64