stream-mdx 0.1.1 → 0.3.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.
- package/README.md +15 -0
- package/package.json +5 -5
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
|
|
@@ -97,6 +100,8 @@ Scoped equivalents:
|
|
|
97
100
|
## Addons
|
|
98
101
|
|
|
99
102
|
- `@stream-mdx/mermaid` (optional Mermaid diagram renderer)
|
|
103
|
+
- `@stream-mdx/theme-tailwind` (optional Tailwind theme CSS)
|
|
104
|
+
- `@stream-mdx/tui` + `@stream-mdx/protocol` (terminal/CLI helpers)
|
|
100
105
|
|
|
101
106
|
Example:
|
|
102
107
|
|
|
@@ -107,9 +112,18 @@ import { MermaidBlock } from "@stream-mdx/mermaid";
|
|
|
107
112
|
<StreamingMarkdown text={content} components={{ mermaid: MermaidBlock }} />;
|
|
108
113
|
```
|
|
109
114
|
|
|
115
|
+
## Terminal / TUI
|
|
116
|
+
|
|
117
|
+
If you're building a terminal UI, use:
|
|
118
|
+
|
|
119
|
+
- `@stream-mdx/protocol` for stable event/type contracts
|
|
120
|
+
- `@stream-mdx/tui` for NDJSON helpers and a snapshot store for applying patches
|
|
121
|
+
|
|
110
122
|
## Docs
|
|
111
123
|
|
|
112
124
|
- Docs site: https://kmccleary3301.github.io/stream-mdx/
|
|
125
|
+
- Live demo: https://kmccleary3301.github.io/stream-mdx/demo
|
|
126
|
+
- Showcase: https://kmccleary3301.github.io/stream-mdx/showcase
|
|
113
127
|
- Manual: `docs/COMPREHENSIVE_PROJECT_DOCUMENTATION.md`
|
|
114
128
|
- API: `docs/PUBLIC_API.md`
|
|
115
129
|
- React integration: `docs/REACT_INTEGRATION_GUIDE.md`
|
|
@@ -125,3 +139,4 @@ import { MermaidBlock } from "@stream-mdx/mermaid";
|
|
|
125
139
|
- `stream-mdx/plugins` – plugin registry + helpers
|
|
126
140
|
- `stream-mdx/plugins/*` – common plugin entrypoints
|
|
127
141
|
- `stream-mdx/core` – structured-clone-safe types + perf utilities
|
|
142
|
+
- `@stream-mdx/theme-tailwind` – optional Tailwind theme CSS
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stream-mdx",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.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.
|
|
118
|
-
"@stream-mdx/plugins": "0.
|
|
119
|
-
"@stream-mdx/react": "0.
|
|
120
|
-
"@stream-mdx/worker": "0.
|
|
117
|
+
"@stream-mdx/core": "0.3.0",
|
|
118
|
+
"@stream-mdx/plugins": "0.3.0",
|
|
119
|
+
"@stream-mdx/react": "0.3.0",
|
|
120
|
+
"@stream-mdx/worker": "0.3.0"
|
|
121
121
|
},
|
|
122
122
|
"peerDependencies": {
|
|
123
123
|
"react": ">=18.2.0",
|