Docs
Start with Getting Started, then React integration, then the API. StreamMDX is designed to be a drop-in replacement for standard markdown renderers with a focus on high-performance streaming.
npm install @stream-mdx/reactStart here if you want the shortest path from installation to a working stream in React or a first look at the non-React entry points.
Learn the core concepts and set up your first stream.
Wire StreamMDX into hooks, components, and router flows.
Complete documentation for props, types, and defaults.
Terminal and non-React entry point, including the minimal repo example path.
These tracks are the real docs IA. React consumers, worker/plugin extenders, TUI consumers, and correctness reviewers should each have a visible path instead of one flat index.
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.
Topic browsing stays secondary to the role tracks, but it still needs enough structure to work as a quick reference map.
- Global settings and defaults
- Worker hosting and core flags
- Custom syntax and extensions
- Worker-side registry
- Shiki + Prism integration
- Streaming-safe renderers
- Sanitization policies
- CSP defaults
- Benchmarks + optimization
- Scheduling heuristics
- Snapshot and unit testing
- Regression capture
- Internals and worker pipeline
- Patch coalescing
- Terminal-based rendering
- Runnable example + JSON stream protocol
If you are scanning rather than reading linearly, use this section as the map from role tracks into the deeper guides and reference material.
- Read by task: Use the role tracks below if you are integrating React, extending worker/plugin behavior, consuming the protocol from a TUI, or validating correctness.
- Guides as deep dives: The Guides section covers styling, MDX and HTML, testing, architecture, benchmarks, deployment, and Mermaid-specific behavior.
- Runnable examples: The docs now expose the minimal TUI example as a first-class page, so terminal consumers can start from a runnable loop and only drop into the protocol spec when they actually need it.