feat: add stream-markdown dependency and update documentation for MarkdownCodeBlockNode usage

Author: Simon-He95

README.md

@@ -173,6 +173,7 @@ yarn add mermaid stream-monaco shiki
 |----------------|---------|---------|---------------------|
 | `mermaid` | >=11 | Progressive Mermaid diagram rendering | Shows code block source |
 | `stream-monaco` | >=0.0.33 | Monaco Editor for interactive code editing | Plain text display |
+| `stream-markdown` | >=0.0.2 | Streaming renderer used by `MarkdownCodeBlockNode` | Plain text display |
 | `shiki` | ^3.13.0 | Syntax highlighting for `MarkdownCodeBlockNode` | Plain text display |
 | `vue-i18n` | >=9 | Internationalization support | Built-in fallback translator |
 
@@ -793,6 +794,24 @@ The library now includes `MarkdownCodeBlockNode` - an alternative code block com
 - **CodeBlockNode** (default): Full-featured code blocks with Monaco Editor integration, copy buttons, expand/collapse, and advanced features
 - **MarkdownCodeBlockNode**: Lightweight markdown-style rendering with syntax highlighting using Shiki
 
+Required peers when using MarkdownCodeBlockNode:
+
+- `stream-markdown` (>=0.0.2)
+- `shiki` (^3.13.0)
+
+Install examples:
+
+```bash
+# pnpm
+pnpm add stream-markdown shiki
+
+# npm
+npm install stream-markdown shiki
+
+# yarn
+yarn add stream-markdown shiki
+```
+
 **When to use MarkdownCodeBlockNode:**
 - You want syntax-highlighted code blocks without Monaco Editor dependencies
 - You prefer a lighter-weight solution for code display
@@ -1342,10 +1361,10 @@ See the [Monaco Editor Integration](#monaco-editor-integration) section for more
 
 **Symptom:** Code blocks show plain text without syntax highlighting when using `MarkdownCodeBlockNode`.
 
-**Solution:** Install the `shiki` peer dependency:
+**Solution:** Install the required peers for `MarkdownCodeBlockNode`:
 
 ```bash
-pnpm add shiki
+pnpm add stream-markdown shiki
 ```
 
 ### TypeScript errors about missing types

README.zh-CN.md

@@ -51,6 +51,7 @@ yarn add vue-renderer-markdown vue
 |------|------|------|----------------|
 | `mermaid` | >=11 | Mermaid 图表 | 展示源代码 |
 | `stream-monaco` | >=0.0.2 | Monaco 编辑器 | 仅显示纯文本 |
+| `stream-markdown` | >=0.0.2 | `MarkdownCodeBlockNode` 所用的流式高亮渲染器 | 仅显示纯文本 |
 | `shiki` | ^3.13.0 | MarkdownCodeBlockNode 语法高亮 | 仅显示纯文本 |
 | `vue-i18n` | >=9 | 国际化 | 内置同步翻译器 |
 
@@ -147,6 +148,24 @@ setCustomComponents({
 })
 ```
 
+使用 MarkdownCodeBlockNode 时需要安装以下 peer 依赖：
+
+- `stream-markdown` (>=0.0.2)
+- `shiki` (^3.13.0)
+
+安装示例：
+
+```bash
+# pnpm
+pnpm add stream-markdown shiki
+
+# npm
+npm install stream-markdown shiki
+
+# yarn
+yarn add stream-markdown shiki
+```
+
 或在实例级启用纯文本：
 
 ```vue
@@ -387,10 +406,10 @@ getUseMonaco()
 
 **现象**：使用 `MarkdownCodeBlockNode` 时代码块仅显示纯文本。
 
-**解决方案**：安装 `shiki` 依赖：
+**解决方案**：安装 `MarkdownCodeBlockNode` 所需依赖：
 
 ```bash
-pnpm add shiki
+pnpm add stream-markdown shiki
 ```
 
 并确保在渲染器中启用了该组件：

package.json

@@ -76,17 +76,24 @@
     "katex": ">=0.16.22",
     "mermaid": ">=11",
     "shiki": "^3.13.0",
+    "stream-markdown": ">=0.0.2",
     "stream-monaco": ">=0.0.2",
     "vue": ">=3.0.0",
     "vue-i18n": ">=9"
   },
   "peerDependenciesMeta": {
+    "katex": {
+      "optional": true
+    },
     "mermaid": {
       "optional": true
     },
     "shiki": {
       "optional": true
     },
+    "stream-markdown": {
+      "optional": true
+    },
     "stream-monaco": {
       "optional": true
     },