Streamdown-rs 🦀

A streaming markdown renderer for modern terminals, written in Rust.

This is a Rust port of Streamdown by kristopolous, bringing the same beautiful terminal markdown rendering with the performance and safety of Rust.

✨ Features

• Streaming rendering - Renders markdown as it arrives, perfect for LLM output
• Syntax highlighting - Full language support via syntect
• Beautiful output - Pretty tables, lists, code blocks with box drawing
• PTY exec mode - Run commands and render their markdown output
• Clipboard integration - Copy code blocks via OSC 52
• Savebrace - Save code blocks to temp files for shell access
• LaTeX support - Convert LaTeX math to Unicode symbols
• Configurable - TOML configuration for colors and behavior
• Cross-platform - Full Unix support, partial Windows support

📦 Installation

From source

git clone https://github.com/fed-stew/streamdown-rs.git
cd streamdown-rs
cargo install --path .

From crates.io (coming soon)

cargo install streamdown

🚀 Quick Start

Pipe markdown content

# Pipe from any command
echo "# Hello World" | sd

# Render a file
cat README.md | sd

# From an LLM
curl -s https://api.openai.com/... | sd

Render a file directly

sd document.md

Execute a command and render output

# Run a command in a PTY and render its markdown output
sd --exec "python chat.py"
sd -e "llm query 'explain rust lifetimes'"

📖 Usage

sd - Streamdown: A streaming markdown renderer for terminals

USAGE:
    sd [OPTIONS] [FILE]

ARGS:
    <FILE>    Markdown file to render (reads from stdin if omitted)

OPTIONS:
    -e, --exec <CMD>       Execute command and render its output
    -w, --width <WIDTH>    Terminal width (default: auto-detect)
    -c, --config <FILE>    Custom config file path
    -s, --scrape <DIR>     Save code blocks to directory
    -d, --debug            Enable debug output
    -h, --help             Print help information
    -V, --version          Print version information

⚙️ Configuration

Streamdown looks for configuration in:

1. $XDG_CONFIG_HOME/streamdown/config.toml
2. ~/.config/streamdown/config.toml
3. ~/.streamdown.toml

Default Configuration

[style]
# Base hue (0.0-1.0) for color theme
hue = 0.6

# Terminal margin (spaces on left)
margin = 2

[style.multipliers]
# HSV multipliers for derived colors
dark = [1.0, 0.8, 0.15]
mid = [1.0, 0.5, 0.4]
symbol = [1.0, 0.6, 0.7]
head = [1.0, 0.4, 0.9]
grey = [0.0, 0.0, 0.5]
bright = [1.0, 0.8, 1.0]

[features]
# Enable OSC 52 clipboard for code blocks
clipboard = true

# Enable savebrace (save code to temp file)
savebrace = true

# Prompt pattern for PTY mode (regex)
prompt_pattern = "[$#>] $"

Color Customization

The color theme is generated from a single base hue using HSV color space. Adjust the hue value (0.0-1.0) to change the overall color scheme:

• 0.0 - Red
• 0.3 - Green
• 0.6 - Blue (default)
• 0.8 - Purple

🎨 Output Examples

Headings

# Level 1 Heading
## Level 2 Heading
### Level 3 Heading

Rendered with bold text and proper centering.

Code Blocks

```python
def hello():
    print("Hello, World!")
```

Rendered with:

• Syntax highlighting
• Box drawing borders
• Language label
• Clipboard/savebrace integration

Tables

| Name  | Age | City    |
|-------|-----|-------  |
| Alice | 30  | NYC     |
| Bob   | 25  | LA      |

Rendered with Unicode box drawing characters.

Lists

- Item 1
  - Nested item
    - Deeply nested
- Item 2

1. First
2. Second
3. Third

Rendered with proper indentation and bullets.

Think Blocks

<think>
Internal reasoning that should be visually distinct...
</think>

Special rendering for LLM "thinking" output.

🔌 Programmatic Usage

Use streamdown as a library in your Rust project:

use streamdown_parser::Parser;
use streamdown_render::Renderer;

fn main() {
    let markdown = "# Hello\n\nThis is **bold** text.";
    
    let mut output = Vec::new();
    let mut parser = Parser::new();
    
    {
        let mut renderer = Renderer::new(&mut output, 80);
        
        for line in markdown.lines() {
            for event in parser.parse_line(line) {
                renderer.render_event(&event).unwrap();
            }
        }
    }
    
    print!("{}", String::from_utf8(output).unwrap());
}

Crate Structure

🔧 Development

Building

cargo build
cargo build --release

Running Tests

# Run all tests
cargo test --workspace

# Run specific crate tests
cargo test -p streamdown-parser

# Run with output
cargo test -- --nocapture

Documentation

cargo doc --workspace --open

🆚 Comparison with Python Version

📄 License

MIT License - see LICENSE for details.

🙏 Acknowledgments

• kristopolous for the original Streamdown Python implementation
• syntect for syntax highlighting
• The Rust community for excellent crates

🤝 Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request