streamdown
Installation
Summary
Streaming-optimized React Markdown renderer with syntax highlighting, diagrams, math, and AI chat integration.
- Supports four optional plugins: code syntax highlighting via Shiki (200+ languages), Mermaid diagrams, LaTeX math rendering, and CJK text support
- Two rendering modes: streaming (with animated caret cursor for AI chat) and static (for blogs and documentation)
- Built-in security features including link safety modals, HTML tag filtering, URL sanitization, and configurable element allowlists
- Requires Tailwind CSS configuration via
@sourcedirective (v4) or content scanning (v3); integrates seamlessly with Vercel AI SDK and other streaming frameworks - Customizable via props for themes, components, controls, and styling through CSS variables and data attributes
SKILL.md
Streamdown
Streaming-optimized React Markdown renderer. Drop-in replacement for react-markdown with built-in streaming support, security, and interactive controls.
Quick Setup
1. Install
npm install streamdown
Optional plugins (install only what's needed):
npm install @streamdown/code @streamdown/mermaid @streamdown/math @streamdown/cjk