Skip to content

XurshidJurayev1/streamdown-angular

Repository files navigation

streamdown-angular — monorepo

Stream‑safe Markdown rendering for Angular, built for AI chat UIs. Angular port of Vercel Streamdown.


This is the Angular workspace for the streamdown-angular library (npm package name; the Angular project folder is ngx-streamdown).

Project Path What
📚 Library projects/ngx-streamdown The publishable package — see its README for full usage docs.
🧪 Demo projects/demo A playground app showing streaming, code, tables, math, Mermaid, i18n, caret.

Develop

npm install

# run the demo playground (http://localhost:4200)
npm start            # = ng serve demo

# build the library → dist/streamdown-angular
npm run build        # = ng build ngx-streamdown

# run the library unit tests (Vitest)
npm test             # = ng test ngx-streamdown --watch=false

If npm start / npm test aren't defined, use the explicit forms: ng serve demo, ng build ngx-streamdown, ng test ngx-streamdown --watch=false.

Publish

ng build ngx-streamdown
cd dist/streamdown-angular
npm publish

Using the library

See projects/ngx-streamdown/README.md for installation, the <ngx-streamdown> component API, optional plugins (Shiki / Mermaid / KaTeX), styling, and i18n.

import { StreamdownComponent } from 'streamdown-angular';
// <ngx-streamdown [content]="markdown()" [caret]="true" />

License

Apache‑2.0 — original work © 2023 Vercel, Inc. (see NOTICE).

About

Angular port of Vercel Streamdown — stream-safe Markdown rendering for AI chat UIs (signals, OnPush, Shiki, tables, Mermaid, KaTeX)

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors