Document remaining Markstream optional peers

This commit is contained in:
Simon He
2026-07-19 21:01:38 +08:00
parent 9c1d571f36
commit 1f1d82ef82
2 changed files with 3 additions and 1 deletions
+1 -1
View File
@@ -34,7 +34,7 @@ Before changing dependencies, inspect:
- the package manager lockfile;
- whether the application uses SSR;
- reset, Tailwind, UnoCSS, or design-system styles;
- required optional features: code highlighting, Monaco, Mermaid, D2, or KaTeX.
- required optional features: code highlighting, enhanced File/Diff surfaces, Monaco, Mermaid, D2, infographic blocks, or KaTeX.
Do not assume the Vue package is correct merely because the source repository is named `markstream-vue`. Select the framework-specific package from the scenario table.
@@ -16,9 +16,11 @@
| Feature | Peer | Supported packages | Activation |
|---------|------|--------------------|------------|
| Lightweight highlighted code blocks | `stream-markdown` | `markstream-vue`, `markstream-vue2`, `markstream-react` | Configure the package's `MarkdownCodeBlockNode` as the `code_block` override |
| Enhanced code blocks and File/Diff surfaces | `stream-diffs` | `markstream-vue` | Install for copy, preview, expand, syntax-highlighting, and File/Diff features |
| Monaco-powered code blocks | `stream-monaco` | All framework packages | Install only when Monaco interactions are required |
| Mermaid diagrams | `mermaid` | All framework packages | Install when Mermaid fences are rendered |
| D2 diagrams | `@terrastruct/d2` | All framework packages | Install when D2 fences are rendered |
| Infographic blocks | `@antv/infographic` | All framework packages | Install when infographic fences are rendered |
| KaTeX math | `katex` | All framework packages | Install and load KaTeX CSS when math is rendered |
## CSS checklist