StreamMDX
HomeDocs

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/react
Docs overviewGetting startedConfigurationPublic APIReact integration
First steps
Getting started

Learn the core concepts and set up your first stream.

Quickstart guide
React integration

Wire StreamMDX into hooks, components, and router flows.

View integration
API reference

Complete documentation for props, types, and defaults.

Explore API
Explore by topic
Configuration
  • Global settings and defaults
  • Worker hosting and core flags
Plugins
  • Custom syntax and extensions
  • Worker-side registry
Highlighting
  • Shiki + Prism integration
  • Streaming-safe renderers
Security
  • Sanitization policies
  • CSP defaults
Performance
  • Benchmarks + optimization
  • Scheduling heuristics
Testing
  • Snapshot and unit testing
  • Regression capture
Architecture
  • Internals and worker pipeline
  • Patch coalescing
TUI
  • Terminal-based rendering
  • JSON stream protocol
What's new
v2.4.0Added support for Mermaid diagrams in streaming mode.
v2.3.8Improved backpressure handling for high-frequency updates.