markstream-svelte 0.0.1-beta.6 → 0.0.2

package/README.md

@@ -1,6 +1,21 @@
 # markstream-svelte
 
-Svelte 5-only renderer aligned with `markstream-vue`, `markstream-vue2`, and `markstream-react`. Svelte 4 is not supported.
+Svelte 5 streaming Markdown renderer for AI chat, LLM token streams, SSE/WebSocket output, incomplete Markdown states, long documents, custom components, Mermaid, KaTeX, Monaco, D2, and Infographic.
+
+## When to use it
+
+Use `markstream-svelte` when Markdown changes while users are reading it:
+LLM output, SSE streams, WebSocket streams, AI chat messages, long generated answers,
+progressive diagrams, math, or code blocks.
+
+For normal chat streaming, start with the raw `content` string path. Use pre-parsed
+`nodes` only when another part of your app already owns the parser or AST state.
+
+## Known limitations
+
+- **Svelte 5 only.** Svelte 4 is not supported.
+- This package is currently beta. Check npm and the [Svelte guide](https://markstream.simonhe.me/guide/svelte) for the latest API maturity.
+- It is not the first choice for short static Markdown or apps that require a fully stable Svelte 4-compatible API.
 
 ## Install
 
@@ -8,7 +23,8 @@ Svelte 5-only renderer aligned with `markstream-vue`, `markstream-vue2`, and `ma
 pnpm add markstream-svelte svelte@^5
 ```
 
-Optional heavy renderers stay as peer dependencies, matching the Vue and React packages:
+Optional heavy renderers stay as peer dependencies, matching the Vue and React packages.
+Plain Markdown does not require these packages:
 
 ```bash
 pnpm add katex mermaid stream-monaco @terrastruct/d2 @antv/infographic

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "markstream-svelte",
   "type": "module",
-  "version": "0.0.1-beta.6",
-  "description": "Svelte Markdown renderer for Markstream, aligned with markstream-vue and markstream-react.",
+  "version": "0.0.2",
+  "description": "Svelte 5 and SvelteKit streaming Markdown renderer for AI chat, LLM token streams, SSE/WebSocket output, incomplete Markdown, Mermaid, KaTeX, Monaco-powered code blocks, and custom Svelte components.",
   "author": "Simon He",
   "license": "MIT",
-  "homepage": "https://github.com/Simon-He95/markstream-vue#readme",
+  "homepage": "https://markstream.simonhe.me/frameworks/svelte",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Simon-He95/markstream-vue.git",
@@ -16,11 +16,40 @@
   },
   "keywords": [
     "svelte",
+    "svelte5",
+    "sveltekit",
     "markdown",
     "markdown-renderer",
+    "svelte-markdown",
+    "svelte-markdown-renderer",
+    "svelte5-markdown",
+    "sveltekit-markdown",
+    "svelte-streaming-markdown",
+    "svelte-ai-chat",
     "streaming-markdown",
-    "markstream",
-    "markstream-svelte"
+    "ai-markdown-renderer",
+    "ai-chat",
+    "llm",
+    "llm-markdown",
+    "llm-streaming",
+    "sse",
+    "sse-markdown",
+    "websocket",
+    "websocket-markdown",
+    "incomplete-markdown",
+    "mermaid",
+    "streaming-mermaid",
+    "katex",
+    "streaming-katex",
+    "streaming-code-blocks",
+    "d2",
+    "infographic",
+    "monaco-editor",
+    "large-documents",
+    "custom-components",
+    "beta",
+    "markstream-svelte",
+    "markstream"
   ],
   "sideEffects": [
     "**/*.css"
@@ -49,7 +78,7 @@
     "@terrastruct/d2": ">=0.1.33",
     "katex": ">=0.16.22",
     "mermaid": ">=11",
-    "stream-monaco": ">=0.0.41",
+    "stream-monaco": ">=0.0.48",
     "svelte": ">=5 <6"
   },
   "peerDependenciesMeta": {
@@ -70,21 +99,21 @@
     }
   },
   "dependencies": {
-    "@floating-ui/dom": "^1.7.6",
+    "@floating-ui/dom": "^1.8.0",
     "markstream-core": "1.0.3",
-    "stream-markdown-parser": "1.0.5"
+    "stream-markdown-parser": "1.1.3"
   },
   "devDependencies": {
-    "@sveltejs/package": "^2.5.7",
+    "@sveltejs/package": "^2.5.8",
     "@sveltejs/vite-plugin-svelte": "^6.2.4",
     "@types/node": "^18.19.130",
-    "autoprefixer": "^10.5.0",
+    "autoprefixer": "^10.5.2",
     "postcss-cli": "^11.0.1",
-    "svelte": "^5.55.7",
-    "svelte-check": "^4.4.8",
+    "svelte": "^5.56.4",
+    "svelte-check": "^4.7.2",
     "tailwindcss": "^3.4.19",
     "typescript": "^5.9.3",
-    "vite": "^7.3.3"
+    "vite": "^7.3.6"
   },
   "scripts": {
     "build": "pnpm --dir ../markstream-core build && svelte-package -i src -o dist && postcss src/index.css -o dist/index.css && cp dist/index.css dist/index.tailwind.css && node ../../scripts/generate-px-css.mjs",
@@ -93,6 +122,6 @@
     "typecheck": "svelte-check --tsconfig ./tsconfig.json",
     "check:core-published": "node ../../scripts/check-core-published.mjs --package-json package.json --core-package-json ../markstream-core/package.json",
     "check:workspace-deps-published": "node ../../scripts/check-workspace-deps-published.mjs --package-json package.json",
-    "release": "pnpm run check:workspace-deps-published && bumpp --commit --no-tag --no-push && pnpm publish --access public && node ../../scripts/tag-package.mjs --package-json package.json --push"
+    "release": "pnpm run check:workspace-deps-published && bumpp --all --commit --no-tag --no-push --execute 'pnpm --workspace-root run docs:llms:generate' && pnpm publish --access public && node ../../scripts/tag-package.mjs --package-json package.json --push"
   }
 }