Sefaria Frontend Toolkit

Appearance

Sefaria Frontend ToolkitBring Sefaria's texts into your product at the level you need

Drop in a tag to show a source, or use the JavaScript tools to fetch checked data and clean its text.

A community-driven project with Sefaria backing and support. The toolkit is experimental; names and APIs may change. License

One source, three views

Micah 6:8, loaded live from Sefaria

The same verse as a Source Card, as checked data, and as cleaned text. The card below is this one tag: <sefaria-source-card sref="Micah 6:8">

If Sefaria can't be reached, the card shows its own error message.

Show texts with one tag @sefaria/web-components

Add one Source Card tag to your page. It loads the text, shows the attribution, and handles loading and errors.

Use components

Get checked data @sefaria/api-client

The client fetches Sefaria data and checks its shape before your code uses it.

Use the data and text tools

Clean text safely @sefaria/text-transform

The text tools clean up Sefaria's markup, vowels, and footnotes for display.

Use the data and text tools

Short answers ​

Will it work in my stack? The components work in any modern browser that runs JavaScript. The client and text tools also run in Node.js. For Python or other languages, call Sefaria's API directly.

Learn more: Install and status

How do I install it? Use the public @sefaria npm packages at 0.1.0-alpha.0, or copy the version-pinned browser script from Start here. No registry token or build step is needed for the script route.

Is it official? It is Sefaria-owned and community-driven with Sefaria backing and support. It remains experimental, not a promise of stable APIs or a support SLA. It began at the Microsoft Global Hackathon 2026.

Why web components? A web component is a custom HTML tag, like <sefaria-source-card>. The same tag works in plain HTML, React, Alpine, and other frameworks.

Learn more: Using custom elements (MDN) · How the toolkit works

Should I use this or Sefaria's own tools? Use Sefaria's API, Linker, source sheets, or data exports when they already do the job. Use this toolkit to put Sefaria texts inside your own JavaScript page or app.

Learn more: Sefaria's own texts and tools

This project began at the Microsoft Global Hackathon 2026. Thank you to Microsoft for sponsoring the hackathon and for the time and platform that helped turn the idea into working software. Sefaria now owns the toolkit, which continues as a community-driven open-source project.

Sefaria Frontend ToolkitCommunity-driven with Sefaria backing and support. GitHub Get support

AI-generated documentation.

About this documentation

Like the codebase, this documentation was scaffolded and written with GitHub Copilot. I don't have a background in technical writing, and wanted to get something out there.

Pages that have not undergone any human review are explicitly marked, but the others may also read funny or need work too. Sorry about that.

Please report any issues so they can be prioritized.

Thanks, Avi