Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

madinah-mushaf:0.1.0 #3750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NaifAlsultan wants to merge 3 commits into typst:main
base: main
Choose a base branch
Loading
from NaifAlsultan:main
Open

madinah-mushaf:0.1.0 #3750

NaifAlsultan wants to merge 3 commits into typst:main from NaifAlsultan:main

Conversation

@NaifAlsultan
Copy link

@NaifAlsultan NaifAlsultan commented Dec 27, 2025

I am submitting

  • a new package
  • an update for a package

Description:

madinah-mushaf allows users to render authentic Quranic text in Typst using the fonts from the King Fahad Complex for the Printing of the Holy Quran.

It supports:

  • Granular Control: Render specific Suras, ranges of Verses, or even specific ranges of Words within a verse.
  • Styling: Optional decorative Quranic brackets and automatic right-to-left enforcement.
  • Bilingual API: Fully usable with both English and Arabic function names.
  • Two Qira'at: Hafs and Warsh.

For more details, feel free to visit my GitHub repository.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE

Copy link
Author

Regarding the two CI warnings:

  • hafs.json file is quite large (1MB).
  • warsh.json file is quite large (1MB).

Both of these JSON files are crucial for the package to function properly. They contain Quranic words mapped to the right font.

This PR is ready for review. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

new A new package submission.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /