markstream-vue 1.0.0 → 1.0.1-beta.0

package/README.md

@@ -318,6 +318,14 @@ const nodes = parseMarkdownToStructure('# Hello\n\nThis is parsed once', md)
 // send `nodes` JSON to the client
 ```
 
+> Warning: `parseMarkdownToStructure` defaults to `streamParse: 'auto'`: compatible `md` instances use `md.stream.parse` for non-final top-level parses and retain the latest source/token cache. Final one-shot parses use the regular parser unless you pass `{ streamParse: true }`; pass `{ streamParse: false }` to opt out. If you reuse one `md` instance for unrelated one-shot documents, pass `{ final: true }` or `{ streamParse: false }`.
+
+```ts
+const nodes = parseMarkdownToStructure(source, md, { final: true })
+```
+
+When `MarkdownRender` parses its own `content`, it intentionally defaults `parseOptions.streamParse` to `true` so streaming parses use `md.stream.parse`. When `final` changes, the renderer invalidates the stream cache and reparses with final semantics to avoid stale loading or unclosed-token state. Pass `:parse-options="{ streamParse: 'auto' }"` to keep final content parses on the regular parser, or `false` to opt out entirely.
+
 ```vue
 <!-- client -->
 <MarkdownRender :nodes="nodesFromServer" />

package/README.zh-CN.md

@@ -310,6 +310,8 @@ const nodes = parseMarkdownToStructure('# Hello\n\n服务端解析一次', md)
 // 将 nodes JSON 下发到客户端
 ```
 
+> 注意：`parseMarkdownToStructure` 默认是 `streamParse: 'auto'`：兼容的 `md` 实例会在非 final 顶层解析时使用 `md.stream.parse`，并保留最近一次 source/token cache。final 一次性解析默认走普通 parser；需要强制 stream 时传 `{ streamParse: true }`，需要关闭时传 `{ streamParse: false }`。如果复用同一个 `md` 解析互不相关的一次性文档，请传 `{ final: true }` 或 `{ streamParse: false }`。
+
 ```vue
 <!-- client -->
 <MarkdownRender :nodes="nodesFromServer" />