qirtaas-js

KO | EN

gitlite — search

#nodejs #reactjs #animation #automation #ai-agent #data-science #ui #self-hosted #kubernetes #editor

(★ 9)

Qirtaas SDK — embeddable rich-text editor for Islamic writing (Quran, hadith, Arabic RTL). @qirtaas/core, @qirtaas/vue, @qirtaas/react.

파일 탐색기

ZIP 다운로드

- - ci.yml
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - tsconfig.json
  - vite.config.ts
  - vite.shared.ts
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - vite.config.ts
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
  - tsconfig.json
  - vite.config.ts
.gitignore
CONTRIBUTING.md
LICENSE
package.json
README.md
SECURITY.md

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Embeddable rich-text editor for Islamic scholarly writing — Qur'an verse and
hadith insertion, mushaf pages, and first-class Arabic/RTL typography. Mount it
on any page with a bounded-height element; it ships its own scoped styles and
never fights the host's CSS or framework.

This repository is the public home of the Qirtaas SDK packages. Issues and pull
requests are welcome here.

| Package | Description |
| --- | --- |
| [`@qirtaas/core`](packages/core) | Framework-agnostic mount API + CDN/UMD bundle |
| [`@qirtaas/vue`](packages/vue) | Idiomatic Vue 3 components (shares the host's Vue) |
| [`@qirtaas/react`](packages/react) | Idiomatic React components (no Vue required in the host) |

## Quickstart

```sh
npm install @qirtaas/core   # or @qirtaas/vue / @qirtaas/react
```

```js
import { createQirtaasClient } from "@qirtaas/core";
import "@qirtaas/core/qirtaas.css";

const qirtaas = createQirtaasClient({
  apiUrl: "https://api.qirtaas.io",
  getToken: () => fetchEmbedJwt(), // your backend exchanges its API key for a short-lived token
});

qirtaas.mountEditor("#editor", { documentId, locale: "ar", theme: "light" });
qirtaas.mountRenderer("#renderer", { shareToken }); // read-only, no user token
```

Full documentation — embedding guides, token exchange, and the hosted API —
lives at **[docs.qirtaas.io](https://docs.qirtaas.io)**.

## Self-hosting (bring your own backend)

The SDK talks to any backend implementing the documented `/v1` contract
(documents + images endpoints; additive changes only). Point `apiUrl` at your
implementation; Qur'an/hadith/mushaf content is served by the hosted content
API. See the backend docs at [docs.qirtaas.io](https://docs.qirtaas.io).

## Developing

```sh
npm install
npm run build   # builds core, then the vue and react wrappers
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

[MIT](LICENSE)

qirtaas-js

파일 탐색기

# CDN으로 사용하기

Was this content helpful?

Recent Feedback

Download README