Skip to content

undivisible/svelte-streamdown

 
 

Svelte Streamdown

Svelte Streamdown is a Svelte 5 streaming markdown renderer for AI chat interfaces. It ports the useful streaming markdown behavior from Vercel's Streamdown into a focused Svelte package and keeps remend for incomplete markdown repair.

Packages

  • packages/svelte-streamdown - the Svelte component package.
  • packages/remend - incomplete markdown repair utilities retained from upstream Streamdown.

Usage

<script lang="ts">
  import { Streamdown } from "svelte-streamdown";
  import "svelte-streamdown/styles.css";

  let markdown = $state("**Streaming** markdown");
</script>

<Streamdown {markdown} animated />

The package exposes:

  • Streamdown - the main Svelte component.
  • styles.css - default markdown styling.

Development

Install dependencies with Bun:

bun install

Run the main quality gates:

bun run format:check
bun run typecheck
bun run lint
bun run test
bun run build

Build only the publishable packages:

bun run build:packages

Run the remend benchmark suite:

bun run bench

License

New Svelte Streamdown code is licensed under MPL-2.0. Apache-2.0 upstream license material is retained in LICENSE-APACHE for copied or derived upstream Streamdown and remend work.

About

Vercel's Streamdown, but for Svelte

Topics

Resources

License

MPL-2.0, Unknown licenses found

Licenses found

MPL-2.0
LICENSE
Unknown
LICENSE-APACHE

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 97.7%
  • Svelte 1.6%
  • Other 0.7%