markstream-vue 1.0.0-rc.0 → 1.0.1-beta.0

package/README.md

@@ -28,7 +28,7 @@ Looking for other frameworks?
 
 Experimental surfaces are the cross-framework adapters, repository skills/prompts, low-level worker entrypoints beyond documented clients, and internal performance/debug props such as `indexKey`, `renderAsFragment`, `debugPerformance`, batch budget internals, and height-estimation experiments.
 
-For the full release contract and Go / No-Go checklist, see [1.0 Release Readiness](./docs/guide/release-1-0.md).
+For the full release contract and Go / No-Go checklist, see [1.0 Release Readiness](./docs/guide/release-1-0.md). For reproducible performance evidence, run `pnpm benchmark:1.0` and use the generated [1.0 Benchmark Report](./docs/guide/benchmark-1-0.md).
 
 ## Contents
 
@@ -81,6 +81,8 @@ For the full release contract and Go / No-Go checklist, see [1.0 Release Readine
 - Playground (interactive demo): https://markstream-vue.simonhe.me/
 - Interactive test page (shareable links, easy reproduction): https://markstream-vue.simonhe.me/test
 - Docs: https://markstream-vue-docs.simonhe.me/guide/
+- Showcase: https://markstream-vue-docs.simonhe.me/guide/showcase
+- 1.0 benchmark report: run `pnpm benchmark:1.0`
 - AI/LLM context (project map): https://markstream-vue-docs.simonhe.me/llms
 - AI/LLM context (中文): https://markstream-vue-docs.simonhe.me/llms.zh-CN
 - One-click StackBlitz demo: https://stackblitz.com/github/Simon-He95/markstream-vue?file=playground/src/App.vue
@@ -316,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" />
@@ -438,17 +448,19 @@ Parse hooks example (match server + client):
 
 - Latest: [Releases](https://github.com/Simon-He95/markstream-vue/releases) — see highlights and upgrade notes.
 - Full history: [CHANGELOG.md](./CHANGELOG.md)
-- Recent highlights (0.0.3-beta.1/beta.0):
-  - Parser bumped to `stream-markdown-parser@0.0.36` for parsing fixes.
-  - Monaco upgrades with more languages/themes + diff-friendly code block tweaks.
-  - HTML/SVG preview dialog and AST debug view in the playground.
+- 1.0 launch notes:
+  - Stable Vue 3 renderer API, SSR imports, CSS exports, Tailwind export, worker client exports, and safe HTML defaults.
+  - `markstream-vue@1.0.0`, `markstream-core@1.0.0`, and `stream-markdown-parser@1.0.0` ship together.
+  - Public benchmark report: run `pnpm benchmark:1.0` or use the `1.0 Benchmark` workflow artifact.
+  - Migration guide: [Migrating to 1.0](./docs/guide/migration-1-0.md).
 
 ## 🧭 Showcase & examples
 
 Build something with markstream-vue? Open a PR to add it here (include a link + 1 screenshot/GIF). Ideal fits: AI/chat UIs, streaming docs, diff/code-review panes, or Markdown-driven pages with embedded Vue components.
 
 - **FlowNote** — streaming Markdown note app demo (SSE + virtual window) — https://markstream-vue.simonhe.me/
-- **AI Chat surface** — playground “test” page showing incremental batches + share links — https://markstream-vue.simonhe.me/test
+- **Diagnostic Studio** — shareable repro links, render-mode switching, diff/thinking/stress samples, annotations, PDF export — https://markstream-vue.simonhe.me/test
+- **1.0 Showcase guide** — launch-ready demo matrix for chat, long docs, code review, diagrams, custom components, and safe HTML — https://markstream-vue-docs.simonhe.me/guide/showcase
 
 ## 📺 Introduction Video
 

package/README.zh-CN.md

@@ -74,6 +74,8 @@
 - Playground（交互演示）： https://markstream-vue.simonhe.me/
 - 交互测试页（可分享链接，便于复现）： https://markstream-vue.simonhe.me/test
 - 文档： https://markstream-vue-docs.simonhe.me/zh/guide/
+- Showcase： https://markstream-vue-docs.simonhe.me/zh/guide/showcase
+- 1.0 benchmark 报告：`pnpm benchmark:1.0`
 - AI/LLM 项目索引（中文）： https://markstream-vue-docs.simonhe.me/llms.zh-CN
 - AI/LLM 项目索引（英文）： https://markstream-vue-docs.simonhe.me/llms
 - 一键 StackBlitz 体验： https://stackblitz.com/github/Simon-He95/markstream-vue?file=playground/src/App.vue
@@ -308,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" />