Skip to main content
Qirtaas is a plug-and-play editor for Islamic content. Drop one component into your app and your users get a rich-text editor that can insert Quran verses, hadith, and honourifics, with full Arabic RTL support plus a read-only renderer for displaying saved documents. The SDK is framework-agnostic. Use it from vanilla JS, or with the thin @qirtaas/react and @qirtaas/vue wrappers.

​
Hosting Options

The editor is free and open-source. The only choice you make is which backend stores documents and powers the content search/synchronisation:
  • Self-host (Free, MIT) — point the SDK at your own implementation of the /v1 contract.
  • Managed Cloud — You hit our backend that serves the live Qirtaas app. You get an API key and ship.
See Self-host vs Cloud for the full comparison.

​
How it fits together

1

Install the SDK

Add @qirtaas/core to your frontend.
2

Mint embed tokens on your backend

Your server exchanges a secret API key for a short-lived embed token — see Authentication. The secret never touches the browser.
3

Mount the editor / renderer

Create a client with createQirtaasClient and call mountEditor or mountRenderer.

​
Next steps

Quickstart

Install to mounted in 60 seconds.

Tutorials

Build authoring, reading, and access control end to end.

Editor

Mount the editor and handle content, autosave and events.

Authentication

Server-side token exchange for embed access.