markstream-vue 0.0.3-beta.1 → 0.0.3-beta.3

package/README.md

@@ -5,24 +5,63 @@
 [![NPM version](https://img.shields.io/npm/v/markstream-vue?color=a1b858&label=)](https://www.npmjs.com/package/markstream-vue)
 [![中文版](https://img.shields.io/badge/docs-中文文档-blue)](README.zh-CN.md)
 [![Docs](https://img.shields.io/badge/docs-vitepress-blue)](https://markstream-vue-docs.simonhe.me/)
+[![Playground](https://img.shields.io/badge/playground-live-34c759)](https://markstream-vue.simonhe.me/)
+[![Test page](https://img.shields.io/badge/test-shareable%20repro-0A84FF)](https://markstream-vue.simonhe.me/test)
 [![NPM downloads](https://img.shields.io/npm/dm/markstream-vue)](https://www.npmjs.com/package/markstream-vue)
 [![Bundle size](https://img.shields.io/bundlephobia/minzip/markstream-vue)](https://bundlephobia.com/package/markstream-vue)
+[![Release](https://img.shields.io/github/v/release/Simon-He95/markstream-vue?display_name=release&logo=github)](https://github.com/Simon-He95/markstream-vue/releases)
+[![Discussions](https://img.shields.io/github/discussions/Simon-He95/markstream-vue?logo=github)](https://github.com/Simon-He95/markstream-vue/discussions)
+[![Discord](https://img.shields.io/discord/986352439269560380?label=discord&logo=discord&logoColor=fff&color=5865F2)](https://discord.gg/vkzdkjeRCW)
+[![Support](https://img.shields.io/badge/support-guide-ff6f61)](./SUPPORT.md)
+[![Security](https://img.shields.io/badge/security-policy-8A2BE2)](./SECURITY.md)
+[![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)
 
+## Contents
+
+- [TL;DR Highlights](#tldr-highlights)
+- [Try It Now](#-try-it-now)
+- [Quick Start](#-quick-start)
+- [Common commands](#-common-commands)
+- [Streaming in 30 seconds](#-streaming-in-30-seconds)
+- [Performance presets](#-performance-presets)
+- [Key props & options](#-key-props--options-cheatsheet)
+- [Where it shines](#-where-it-shines)
+- [FAQ](#-faq-quick-answers)
+- [Why markstream-vue](#-why-markstream-vue-over-a-typical-markdown-renderer)
+- [Releases](#-releases)
+- [Showcase](#-showcase--examples)
+- [Contributing & community](#-contributing--community)
+- [Community & support](#-community--support)
+- [Troubleshooting](#troubleshooting--common-issues)
 > 📖 All detailed documentation, API, examples, and advanced usage have been migrated to the VitePress documentation site:
 > https://markstream-vue-docs.simonhe.me/guide/
 
-## 🚀 Playground & Demo
+## TL;DR Highlights
+
+- Purpose-built for **streaming Markdown** (AI/chat/SSE) with zero flicker and predictable memory.
+- **Two render modes**: virtual window for long docs, incremental batching for “typing” effects.
+- **Progressive diagrams** (Mermaid) and **streaming code blocks** (Monaco/Shiki) that keep up with diffs.
+- Works with **raw Markdown strings or pre-parsed nodes**, supports **custom Vue components** inline.
+- TypeScript-first, ship-ready defaults — import CSS and render.
+
+## 🚀 Try It Now
 
 - Playground (interactive demo): https://markstream-vue.simonhe.me/
-- Interactive test page: https://markstream-vue.simonhe.me/test
+- Interactive test page (shareable links, easy reproduction): https://markstream-vue.simonhe.me/test
+- Docs: https://markstream-vue-docs.simonhe.me/guide/
+- One-click StackBlitz demo: https://stackblitz.com/github/Simon-He95/markstream-vue?file=playground/src/App.vue
+- Changelog: [CHANGELOG.md](./CHANGELOG.md)
+- Nuxt playground: `pnpm play:nuxt`
+- Discord: https://discord.gg/vkzdkjeRCW
 
-Try the interactive test page to quickly verify and debug:
-https://markstream-vue.simonhe.me/test
+## 💬 Community & support
 
-This page provides a left editor and right live preview (powered by this library). It includes "generate & copy share link" functionality, encoding your input into the URL for sharing. If the input is too long, fallback options are provided to open directly or pre-fill a GitHub Issue.
+- Discussions: https://github.com/Simon-He95/markstream-vue/discussions
+- Discord: https://discord.gg/vkzdkjeRCW
+- Issues: please use templates and attach a repro link (https://markstream-vue.simonhe.me/test)
 
-You can use this page to reproduce rendering issues, verify math/Mermaid/code block behavior, and quickly generate shareable links or reproducible issues.
+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).
 
 ## ⚡ Quick Start
 
@@ -50,6 +89,123 @@ createApp({
 
 Import `markstream-vue/index.css` after your reset (e.g., Tailwind `@layer components`) so renderer styles win over utility classes. Install optional peers such as `stream-monaco`, `shiki`, `mermaid`, and `katex` only when you need Monaco code blocks, Shiki highlighting, diagrams, or math.
 
+Enable heavy peers only when needed:
+
+```ts
+import { enableKatex, enableMermaid } from 'markstream-vue'
+import 'markstream-vue/index.css'
+
+// after you install `mermaid` / `katex` peers
+enableMermaid()
+enableKatex()
+```
+
+### Nuxt quick drop-in
+
+```ts
+// plugins/markstream-vue.client.ts
+import { defineNuxtPlugin } from '#app'
+import MarkdownRender from 'markstream-vue'
+import 'markstream-vue/index.css'
+
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.vueApp.component('MarkdownRender', MarkdownRender)
+})
+```
+
+Then use `<MarkdownRender :content="md" />` in your pages.
+
+## 🛠️ Common commands
+
+- `pnpm dev` — playground dev server
+- `pnpm play:nuxt` — Nuxt playground dev
+- `pnpm build` — library + CSS build
+- `pnpm test` — Vitest suite (`pnpm test:update` for snapshots)
+- `pnpm typecheck` / `pnpm lint` — type and lint checks
+
+## ⏱️ Streaming in 30 seconds
+
+Render streamed Markdown (SSE/websocket) with incremental updates:
+
+```ts
+import type { ParsedNode } from 'markstream-vue'
+import MarkdownRender, {
+  getMarkdown,
+
+  parseMarkdownToStructure
+} from 'markstream-vue'
+import { ref } from 'vue'
+
+const nodes = ref<ParsedNode[]>([])
+const buffer = ref('')
+const md = getMarkdown()
+
+function addChunk(chunk: string) {
+  buffer.value += chunk
+  nodes.value = parseMarkdownToStructure(buffer.value, md)
+}
+
+// e.g., inside your SSE/onmessage handler
+eventSource.onmessage = event => addChunk(event.data)
+
+// template
+// <MarkdownRender
+//   :nodes="nodes"
+//   :max-live-nodes="0"
+//   :batch-rendering="{
+//     renderBatchSize: 16,
+//     renderBatchDelay: 8,
+//   }"
+// />
+```
+
+Switch rendering style per surface:
+
+- Virtualized window (default): steady scrolling and memory usage for long docs.
+- Incremental batches: set `:max-live-nodes="0"` for AI-like “typing” with lightweight placeholders.
+
+### SSR / Worker usage (deterministic output)
+
+Pre-parse Markdown on the server or in a worker and render typed nodes on the client:
+
+```ts
+// server or worker
+import { getMarkdown, parseMarkdownToStructure } from 'markstream-vue'
+
+const md = getMarkdown()
+const nodes = parseMarkdownToStructure('# Hello\n\nThis is parsed once', md)
+// send `nodes` JSON to the client
+```
+
+```vue
+<!-- client -->
+<MarkdownRender :nodes="nodesFromServer" />
+```
+
+This avoids client-side parsing and keeps SSR/hydration deterministic.
+
+### Hybrid: SSR + streaming handoff
+
+- Server: parse the first Markdown batch to nodes and serialize `initialNodes` (and the raw `initialMarkdown` if you also stream later chunks).
+- Client: hydrate with the same parser options, then keep streaming:
+
+```ts
+import type { ParsedNode } from 'markstream-vue'
+import { getMarkdown, parseMarkdownToStructure } from 'markstream-vue'
+import { ref } from 'vue'
+
+const nodes = ref<ParsedNode[]>(initialNodes)
+const buffer = ref(initialMarkdown)
+const md = getMarkdown() // match server setup
+
+function addChunk(chunk: string) {
+  buffer.value += chunk
+  nodes.value = parseMarkdownToStructure(buffer.value, md)
+}
+```
+
+This avoids re-parsing SSR content while letting later SSE/WebSocket chunks continue the stream.
+
 ## ⚙️ Performance presets
 
 - **Virtual window (default)** – keep `max-live-nodes` at its default `320` to enable virtualization. Nodes render immediately and the renderer keeps a sliding window of elements mounted so long docs remain responsive without showing skeleton placeholders.
@@ -57,6 +213,99 @@ Import `markstream-vue/index.css` after your reset (e.g., Tailwind `@layer compo
 
 Pick one mode per surface: virtualization for best scrollback and steady memory usage, or incremental batching for AI-style “typing” previews.
 
+> Tip: In chats, combine `max-live-nodes="0"` with small `renderBatchSize` (e.g., `16`) and a tiny `renderBatchDelay` (e.g., `8ms`) to keep the “typing” feel smooth without jumping large chunks. Tune `renderBatchBudgetMs` down if you need to cap CPU per frame.
+
+## 🧰 Key props & options (cheatsheet)
+
+- `content` vs `nodes`: pass raw Markdown or pre-parsed nodes (from `parseMarkdownToStructure`).
+- `max-live-nodes`: `320` (default virtualization) or `0` (incremental batches).
+- `batchRendering`: fine-tune batches with `initialRenderBatchSize`, `renderBatchSize`, `renderBatchDelay`, `renderBatchBudgetMs`.
+- `enableMermaid` / `enableKatex` / `enableMonaco`: opt-in heavy deps when needed.
+- `parse-options`: reuse parser hooks (e.g., `preTransformTokens`, `requireClosingStrong`) on the component.
+- `custom-components`: register inline Vue components for custom tags/markers.
+
+Example: map Markdown placeholders to Vue components
+
+```ts
+import { setCustomComponents } from 'markstream-vue'
+
+setCustomComponents({
+  CALLOUT: () => import('./components/Callout.vue'),
+})
+
+// Markdown: [[CALLOUT:warning title="Heads up" body="Details here"]]
+```
+
+Or pass per-renderer:
+
+```vue
+<MarkdownRender
+  :content="doc"
+  :custom-components="{
+    CALLOUT: () => import('./components/Callout.vue'),
+  }"
+/>
+```
+
+Parse hooks example (match server + client):
+
+```vue
+<MarkdownRender
+  :content="doc"
+  :parse-options="{
+    requireClosingStrong: true,
+    preTransformTokens: (tokens) => tokens,
+  }"
+/>
+```
+
+## 🔥 Where it shines
+
+- AI/chat UIs with long-form answers and Markdown tokens arriving over SSE/websocket.
+- Docs, changelogs, and knowledge bases that need instant load but stay responsive as they grow.
+- Streaming diffs and code review panes that benefit from Monaco live updates.
+- Diagram-heavy content that should render progressively (Mermaid) without blocking.
+- Embedding Vue components in Markdown-driven surfaces (callouts, widgets, CTA buttons).
+
+## ❓ FAQ (quick answers)
+
+- Mermaid/KaTeX not rendering? Install the peer (`mermaid` / `katex`) and pass `:enable-mermaid="true"` / `:enable-katex="true"` or call the loader setters.
+- Bundle size: peers are optional and not bundled; import only `markstream-vue/index.css` once. Use Shiki (`MarkdownCodeBlockNode`) when Monaco is too heavy.
+- Custom UI: register components via `setCustomComponents` (global) or `custom-components` prop, then emit markers/placeholders in Markdown and map them to Vue components.
+
+## 🆚 Why markstream-vue over a typical Markdown renderer?
+
+| Needs | Typical Markdown preview | markstream-vue |
+| --- | --- | --- |
+| Streaming input | Re-renders whole tree, flashes | Incremental batches with virtual windowing |
+| Large code blocks | Slow re-highlight | Monaco streaming updates + Shiki option |
+| Diagrams | Blocks while parsing | Progressive Mermaid with graceful fallback |
+| Custom UI | Limited slots | Inline Vue components & typed nodes |
+| Long docs | Memory spikes | Configurable live-node cap for steady usage |
+
+## 🗺️ Roadmap (snapshot)
+
+- More “instant start” templates (Vite + Nuxt + Tailwind) and updated StackBlitz.
+- Additional codeblock presets (diff-friendly Shiki themes, Monaco decoration helpers).
+- Cookbook docs for AI/chat patterns (SSE/WebSocket, retry/resume, markdown mid-states).
+- More showcase examples for embedding Vue components inside Markdown surfaces.
+
+## 📦 Releases
+
+- 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.
+
+## 🧭 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
+
 ## 📺 Introduction Video
 
 A short video introduces the key features and usage of markstream-vue:
@@ -79,6 +328,25 @@ Watch on Bilibili: [Open in Bilibili](https://www.bilibili.com/video/BV17Z4qzpE9
 - 🎨 Flexible code block rendering: choose Monaco editor (`CodeBlockNode`) or lightweight Shiki highlighting (`MarkdownCodeBlockNode`)
 - 🧰 Parser toolkit: [`stream-markdown-parser`](./packages/markdown-parser) now documents how to reuse the parser in workers/SSE streams and feed `<MarkdownRender :nodes>` directly, plus APIs for registering global plugins and custom math helpers.
 
+## 🙌 Contributing & community
+
+- Read the contributor guide: [CONTRIBUTING.md](./CONTRIBUTING.md) and follow the PR template.
+- Be kind and follow the [Code of Conduct](./CODE_OF_CONDUCT.md).
+- Issues: use templates for bugs/requests; attach a repro from https://markstream-vue.simonhe.me/test when possible.
+- Questions? Start a discussion: https://github.com/Simon-He95/markstream-vue/discussions
+- Chat live: Discord https://discord.gg/vkzdkjeRCW
+- Looking to contribute? Start with [good first issues](https://github.com/Simon-He95/markstream-vue/labels/good%20first%20issue).
+- Support guide: [SUPPORT.md](./SUPPORT.md)
+- PRs: follow Conventional Commits, add tests for parser/render changes, and include screenshots/GIFs for UI tweaks.
+- If the project helps you, consider starring and sharing the repo — it keeps the work sustainable.
+- Security: see [SECURITY.md](./SECURITY.md) to report vulnerabilities privately.
+
+### Quick ways to help
+
+- Add repro links/screenshots to existing issues.
+- Improve docs/examples (especially streaming + SSR/worker patterns).
+- Share playground/test links that showcase performance edge cases.
+
 ## Troubleshooting & Common Issues
 
 Troubleshooting has moved into the docs:
@@ -87,12 +355,18 @@ https://markstream-vue-docs.simonhe.me/guide/troubleshooting
 If you can't find a solution there, open a GitHub issue:
 https://github.com/Simon-He95/markstream-vue/issues
 
+### Report an issue quickly
+
+1. Reproduce in the test page and click “generate share link”: https://markstream-vue.simonhe.me/test
+2. Open a bug report with the link and a screenshot: https://github.com/Simon-He95/markstream-vue/issues/new?template=bug_report.yml
+
 ## Thanks
 
 This project uses and benefits from:
 - [stream-monaco](https://github.com/Simon-He95/stream-monaco)
 - [stream-markdown](https://github.com/Simon-He95/stream-markdown)
 - [mermaid](https://mermaid-js.github.io/mermaid)
+- [katex](https://katex.org/)
 - [shiki](https://github.com/shikijs/shiki)
 - [markdown-it-ts](https://github.com/Simon-He95/markdown-it-ts)
 
@@ -104,4 +378,4 @@ Thanks to the authors and contributors of these projects!
 
 ## License
 
-[MIT](./LICENSE) © [Simon He](https://github.com/Simon-He95)
+[MIT](./license) © [Simon He](https://github.com/Simon-He95)