Streamdown is a React component designed as a drop-in replacement for react-markdown, optimized for AI-powered streaming applications. It addresses the challenges of tokenizing and streaming Markdown content, ensuring safe and perfectly formatted output.
Key Features:
- Built-in Typography Styles: Offers pre-defined Tailwind CSS classes for common Markdown elements.
- GitHub Flavored Markdown (GFM) Support: Supports task lists, tables, and more.
- Interactive Code Blocks: Uses Shiki for code highlighting with a copy button.
- Mathematical Expressions: Supports LaTeX math expressions via remark-math and KaTeX.
- Interactive Mermaid Diagrams: Renders Mermaid diagrams with a button to render them.
- Unterminated Markdown Block Styling: Parses and styles incomplete Markdown blocks.
- Built-in Security Hardening: Ensures untrusted Markdown doesn't link to unexpected origins, preventing prompt injection.
Use Cases:
- AI Elements Response Component: Powers the AI Elements Response component for streaming Markdown.
- Standalone Package: Can be installed as a standalone package for any React application requiring Markdown rendering.
- AI-Powered Applications: Ideal for applications that stream Markdown content generated by AI, ensuring consistent and secure formatting.
