stream-mdx 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +20 -0
  3. package/dist/core.d.cts +2 -2
  4. package/dist/core.d.ts +2 -2
  5. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # stream-mdx
2
2
 
3
+ ## 0.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Refine streaming scheduling and list layout, add worker append batching/debug state support, and refresh docs/README examples.
8
+ - Updated dependencies
9
+ - @stream-mdx/core@0.1.1
10
+ - @stream-mdx/react@0.1.1
11
+ - @stream-mdx/worker@0.1.1
12
+ - @stream-mdx/plugins@0.1.1
13
+
3
14
  ## 0.1.0
4
15
 
5
16
  ### Minor Changes
package/README.md CHANGED
@@ -78,6 +78,9 @@ export default function App() {
78
78
  - `tableElements`: override table tags (e.g. Shadcn table wrappers).
79
79
  - `htmlElements`: override HTML tag renders (when HTML is enabled).
80
80
  - `mdxComponents`: MDX component registry (when MDX compilation is enabled).
81
+ - `caret`: show a streaming caret while blocks are still in-flight.
82
+ - `linkSafety`: intercept link clicks and require confirmation before navigation.
83
+ - `deferHeavyBlocks`: defer heavy blocks (e.g. Mermaid) until in view/idle.
81
84
  - `scheduling`: patch scheduler/backpressure knobs.
82
85
 
83
86
  ## Plugins
@@ -94,9 +97,25 @@ Scoped equivalents:
94
97
 
95
98
  - `@stream-mdx/plugins/document` (etc)
96
99
 
100
+ ## Addons
101
+
102
+ - `@stream-mdx/mermaid` (optional Mermaid diagram renderer)
103
+ - `@stream-mdx/theme-tailwind` (optional Tailwind theme CSS)
104
+
105
+ Example:
106
+
107
+ ```tsx
108
+ import { StreamingMarkdown } from "stream-mdx";
109
+ import { MermaidBlock } from "@stream-mdx/mermaid";
110
+
111
+ <StreamingMarkdown text={content} components={{ mermaid: MermaidBlock }} />;
112
+ ```
113
+
97
114
  ## Docs
98
115
 
99
116
  - Docs site: https://kmccleary3301.github.io/stream-mdx/
117
+ - Live demo: https://kmccleary3301.github.io/stream-mdx/demo
118
+ - Showcase: https://kmccleary3301.github.io/stream-mdx/showcase
100
119
  - Manual: `docs/COMPREHENSIVE_PROJECT_DOCUMENTATION.md`
101
120
  - API: `docs/PUBLIC_API.md`
102
121
  - React integration: `docs/REACT_INTEGRATION_GUIDE.md`
@@ -112,3 +131,4 @@ Scoped equivalents:
112
131
  - `stream-mdx/plugins` – plugin registry + helpers
113
132
  - `stream-mdx/plugins/*` – common plugin entrypoints
114
133
  - `stream-mdx/core` – structured-clone-safe types + perf utilities
134
+ - `@stream-mdx/theme-tailwind` – optional Tailwind theme CSS
package/dist/core.d.cts CHANGED
@@ -2,6 +2,8 @@ export * from '@stream-mdx/core';
2
2
  import '@stream-mdx/react';
3
3
  import '@stream-mdx/plugins';
4
4
  import '@stream-mdx/worker';
5
+ import '@stream-mdx/worker/mdx-compile';
6
+ import '@stream-mdx/worker/node';
5
7
  import '@stream-mdx/plugins/base';
6
8
  import '@stream-mdx/plugins/callouts';
7
9
  import '@stream-mdx/plugins/document';
@@ -11,6 +13,4 @@ import '@stream-mdx/plugins/math';
11
13
  import '@stream-mdx/plugins/mdx';
12
14
  import '@stream-mdx/plugins/registry';
13
15
  import '@stream-mdx/plugins/tables';
14
- import '@stream-mdx/worker/mdx-compile';
15
- import '@stream-mdx/worker/node';
16
16
  import '@stream-mdx/plugins/math/renderer';
package/dist/core.d.ts CHANGED
@@ -2,6 +2,8 @@ export * from '@stream-mdx/core';
2
2
  import '@stream-mdx/react';
3
3
  import '@stream-mdx/plugins';
4
4
  import '@stream-mdx/worker';
5
+ import '@stream-mdx/worker/mdx-compile';
6
+ import '@stream-mdx/worker/node';
5
7
  import '@stream-mdx/plugins/base';
6
8
  import '@stream-mdx/plugins/callouts';
7
9
  import '@stream-mdx/plugins/document';
@@ -11,6 +13,4 @@ import '@stream-mdx/plugins/math';
11
13
  import '@stream-mdx/plugins/mdx';
12
14
  import '@stream-mdx/plugins/registry';
13
15
  import '@stream-mdx/plugins/tables';
14
- import '@stream-mdx/worker/mdx-compile';
15
- import '@stream-mdx/worker/node';
16
16
  import '@stream-mdx/plugins/math/renderer';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stream-mdx",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "StreamMDX convenience package (re-exports @stream-mdx/*).",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -114,10 +114,10 @@
114
114
  "prepack": "npm run build"
115
115
  },
116
116
  "dependencies": {
117
- "@stream-mdx/core": "0.1.0",
118
- "@stream-mdx/plugins": "0.1.0",
119
- "@stream-mdx/react": "0.1.0",
120
- "@stream-mdx/worker": "0.1.0"
117
+ "@stream-mdx/core": "0.2.0",
118
+ "@stream-mdx/plugins": "0.2.0",
119
+ "@stream-mdx/react": "0.2.0",
120
+ "@stream-mdx/worker": "0.2.0"
121
121
  },
122
122
  "peerDependencies": {
123
123
  "react": ">=18.2.0",