markstream-octane 0.0.56-beta.4 → 0.1.0-beta.3
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 +10 -3
- package/dist/client/index.js +1 -1
- package/dist/index.css +1 -1
- package/dist/index.d.ts +68 -120
- package/dist/index.px.css +1 -1
- package/dist/index.tailwind.css +37 -173
- package/dist/server/index.js +1 -1
- package/dist/server.d.ts +67 -120
- package/dist/tailwind.cjs +1 -1
- package/dist/tailwind.js +1 -1
- package/dist/types/components/CodeBlockNode/monaco.d.ts +1 -1
- package/dist/types/components/CodeBlockNode/streamDiffs.d.ts +2 -0
- package/dist/types/components/NodeRenderer/preloadStreamDiffs.d.ts +2 -0
- package/dist/types/index.d.ts +1 -3
- package/dist/types/server-renderer/index.d.ts +1 -3
- package/dist/types/server.d.ts +0 -2
- package/dist/types/types/component-props.d.ts +53 -65
- package/dist/types/types.d.ts +13 -22
- package/dist/types/utils/languageIcon.d.ts +2 -1
- package/package.json +24 -30
package/README.md
CHANGED
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
# markstream-octane
|
|
2
2
|
|
|
3
|
-
Native Octane streaming Markdown renderer for AI chat, SSE/WebSocket output, incomplete Markdown, Mermaid, KaTeX,
|
|
3
|
+
Native Octane streaming Markdown renderer for AI chat, SSE/WebSocket output, incomplete Markdown, Mermaid, KaTeX, and stream-diffs enhanced code blocks.
|
|
4
4
|
|
|
5
5
|
`markstream-octane` is compiled with the Octane compiler and runs on the Octane client and server runtimes. It does not require a React root or React compatibility layer. The published package contains precompiled JavaScript, declarations, styles, and workers, so consumers do not need to compile TSRX from `node_modules`.
|
|
6
6
|
|
|
7
|
+
The coordinated 2.0 family beta will use `markstream-octane@next`. Before installing, verify that `npm view markstream-octane@next version` reports `0.1.0-beta.1`. It removes the Monaco and Shiki code-block APIs in favor of `stream-diffs`; read the [coordinated 2.0 family migration guide](https://markstream.simonhe.me/guide/migration-2-0) before upgrading.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add markstream-octane@next octane@^0.1.21 stream-diffs
|
|
11
|
+
```
|
|
12
|
+
|
|
7
13
|
## Install
|
|
8
14
|
|
|
9
15
|
```bash
|
|
@@ -16,13 +22,14 @@ Optional renderer features are peer dependencies. Install only the features used
|
|
|
16
22
|
|
|
17
23
|
| Feature | Package |
|
|
18
24
|
| --- | --- |
|
|
19
|
-
|
|
|
20
|
-
| Monaco editor code blocks | `stream-monaco` |
|
|
25
|
+
| Enhanced code blocks | `stream-diffs` |
|
|
21
26
|
| Mermaid diagrams | `mermaid` |
|
|
22
27
|
| KaTeX math | `katex` |
|
|
23
28
|
| D2 diagrams | `@terrastruct/d2` |
|
|
24
29
|
| Infographic blocks | `@antv/infographic` |
|
|
25
30
|
|
|
31
|
+
Enhanced code blocks resolve to `stream-diffs` automatically. Direct `CodeBlockNode` and top-level `NodeRenderer` both accept the shared `codeBlockOptions` / `CodeBlockOptions` contract; `maxHeight` and the single symmetric `padding` value use numeric CSS pixels. Use `codeBlockProps` for header and toolbar controls. Markstream keeps theme, code/language, streaming state, header, mounting, reveal, and disposal host-owned. Themes are registered names and `themes` is the `[dark, light]` pair. An old Monaco JSON theme is not accepted directly: first convert it to a Shiki `ThemeRegistration`, then call `registerCustomTheme(name, loader)` from `stream-diffs/pierre`; see the [coordinated 2.0 family migration guide](https://markstream.simonhe.me/guide/migration-2-0).
|
|
32
|
+
|
|
26
33
|
## Compiler setup
|
|
27
34
|
|
|
28
35
|
Octane source components use the `.tsrx` extension. Add the Octane compiler to Vite:
|