Building blocks/Annotations

Quran Tajweed

Stable

Tajweed rules applied to their exact places in the Quran, reviewed by specialists and ready for use in applications.

Quick startquran-tajweed
Package
@quran.ws/tajwid-annotations
Version
0.1.0
Rules
182 authored · 127 produce spans
Spans
147,255 precomputed

What it provides

  • A corpus of 182 tajweed rules written by scholars in a compact Arabic notation
  • 147,255 spans over 6,235 ayahs — 20:1 has none — tied to a digest of the exact text they were computed from
  • An engine that reports positions in the text, never markup

Use it when you need

Use it for Tajweed colouring, explaining rules while reading, and building recitation and Tajweed-learning tools.

  • Tajweed highlighting without changing the source Quran text
  • Asking which ayahs show a given rule
  • Annotating your own text edition

Not for

See it work

Several things this block does, each running on data from the repository itself.

Any ayah of the muṣḥaf: switch topics on and off, press a stretch for the ruling behind it, isolate one rule.

Live

Loading the corpus…

Spans and rules from the published dataset, tied to the digest of the text they were computed against.

Provenance

Every dataset identifies its source, edition, riwayah, version, and verification status. The digest lets you confirm the file you ship is the file that was verified.

View full provenance →
Quran TajweedStable
Repositoryquran-ws/quran-tajweed
Package@quran.ws/tajwid-annotations
Version0.1.0
LicenceCC BY 4.0 (the corpus, annotations and editions) · MIT (the engine and tools)
Publicyes

Quick start

The shortest path to something running. The repository’s README covers the rest.

$ # not published yet — read the annotation and rules JSON from the release
import { unpack } from "@quran.ws/tajwid";
 
const spans = unpack(annotations, corpus, '112:1');
  → [{ start, end, ruleId }, …]
Read the full documentation →

Works with

Blocks meet through shared references, not through a framework. Each of these understands something this block produces.

Quran TextThe unchanged text the spans point into.Quran EngineProject spans as layered styles.