Skip to content
quran-wsPublic

About

SVG Mushaf pages with mapped ayah positions for displaying and interacting with printed Quran pages in apps and websites.

Topics

Resources

Contributing

Stars

58 stars

Watchers

0 watching

Forks

Latest commit

 

History

76 Commits

Folders and files

Repository files navigation

Quran SVG — Pages & Assets, Stable

Vector Mushaf pages in SVG, with the position of every ayah mapped on the page.

See it work Documentation

Use it when you want to display printed Mushaf pages in a website or application and make individual ayahs selectable or connect them to recitation, Tafsir, and other features.

صفحات مصاحف جاهزة بصيغة SVG، مع إحداثيات كل آية داخل الصفحة.

استخدمه عندما تريد عرض صفحة المصحف كما هي في موقع أو تطبيق، مع إمكانية تحديد الآيات وربطها بالتلاوة أو التفسير أو غيرها من وظائف التطبيق.

Riwayat 5
Ayah polygons 31,118
Licence CC BY 4.0 for the metadata and polygon layer, MIT for tools/; attribution waived for use inside a product
# one page
curl -O https://raw.githubusercontent.com/quran-ws/quran-svg/main/mushafs/hafs/kfqc/svg/001.svg

# one whole mushaf, without the 5.29 GiB a plain `git clone` fetches
git clone --depth 1 --filter=blob:none --sparse https://github.com/quran-ws/quran-svg.git
cd quran-svg && git sparse-checkout set mushafs/hafs/kfqc

On the CDN

Releases are mirrored to cdn.quran.ws under immutable, versioned URLs, so an application can fetch one page over HTTPS without cloning the repository:

https://cdn.quran.ws/svg/pages/v1.1.1/manifest.json
https://cdn.quran.ws/svg/pages/v1.1.1/hafs-kfqc/001.svg    the artwork
https://cdn.quran.ws/svg/pages/v1.1.1/hafs-kfqc/001.json   its ayah polygons

Every mushaf in the release is published under its own edition folder: douri-kfqc, hafs-kfqc, qalon-kfqc, shubah-kfqc and warsh-kfqc. A page that holds two surahs also has a per-surah file beside it, such as 106-surah4.svg. Only the raw svg set goes up, because the CDN negotiates zstd, brotli or gzip per client.

A folder is written once and never rewritten, so every file is served Cache-Control: immutable. manifest.json lists each file with its size and sha256. https://cdn.quran.ws/svg/pages/latest.json names the current version.

The CDN mirrors the GitHub release, which remains the canonical artifact.

Where the documentation is

Everything about using it lives on the site. This repository is the source.

Overview and demo quran.ws/blocks/quran-svg
Reference quran.ws/docs/reference/quran-svg
Display a complete Muṣḥaf page quran.ws/docs/build/display-page
Highlight an ayah quran.ws/docs/build/highlight-ayah
Work offline quran.ws/docs/build/offline
Licensing in full quran.ws/docs/reference/licensing

What is in here

mushafs/ the artwork and the ayah polygon layer, one directory per muṣḥaf
tools/ how the polygon layer is built and audited
docs/ how the polygon layer ships — stacking order, the two polygon shapes, the opening spread · getting the files — what to fetch, and what not to clone · where the artwork came from — the source bundle and digest behind each muṣḥaf

Issues and pull requests are welcome here. Everything that is not about changing this repository is on the site.

About

SVG Mushaf pages with mapped ayah positions for displaying and interacting with printed Quran pages in apps and websites.

Topics

Resources

Contributing

Stars

58 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages