Browse docs
Guides
Deep dives and implementation notes for StreamMDX.
Install the React package, mount the renderer, and learn the public API and integration constraints.
Work from the plugin cookbook into the worker internals and correctness contract before changing parser behavior.
Start from the dedicated terminal guide, then drop into lower-level runtime and protocol details only where needed.
Use the testing and baseline guide first, then the repo-side correctness contract and execution plan when you need the stronger guarantees.
Mental model, streaming loop, and how StreamMDX keeps output stable while data arrives.
Component overrides, HTML mappings, and styling patterns that preserve incremental rendering.
MDX compile strategies, HTML safety, and when to use each feature.
Worker-side features, custom syntax hooks, and opt-in add-ons.
Scheduling, queue control, metrics, and how to tune for latency or throughput.
Render formatting early while streaming, with safe per-feature toggles.
Local-only HTML/style snapshot baselines and perf capture workflow.
How to compare StreamMDX against alternatives and interpret perf results.
Patch coalescing, worker pipeline, and rendering invariants.
Worker hosting, CSP guidance, sanitization, and production-ready defaults.
Diagram rendering with the optional Mermaid addon and UX patterns for toggling views.