Skip to content

About

Ripple/TSRX streaming markdown components inspired by Streamdown

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

ripple-streamdown

Streaming markdown components for Ripple / TSRX, inspired by Streamdown. Renders markdown incrementally as tokens arrive (AI chat / live output), with optional syntax highlighting (Shiki), diagrams (Mermaid), and math (KaTeX).

Distributed as compiled JS from GitHub version tags (no npm package). Each .tsrx is built to client + server variants via @tsrx/ripple; the browser/worker export conditions route them per environment, so it works as a normal dependency of a Ripple SSR app.

Install

bun add github:ethan-huo/ripple-streamdown#v0.2.0

Exports

Export Module
. src/streamdown.tsrx — the component
./core src/core.ts — markdown → hast pipeline
./shiki src/shiki.tsrx — Shiki code blocks (needs shiki)
./mermaid src/mermaid.tsrx — Mermaid diagrams (needs mermaid)
./types src/types.ts
./styles.css base styles

Peer dependencies

  • ripple >= 0.3.0 (required)
  • shiki >= 3.0.0 (optional — only for ./shiki)
  • mermaid >= 11.0.0 (optional — only for ./mermaid)

Releasing

See PUBLISHING.md. Bump package.json#version, push to main, and CI tags v${version}.

About

Ripple/TSRX streaming markdown components inspired by Streamdown

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages