Skip to content

Conversation

@NaifAlsultan
Copy link

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

@typst-package-check typst-package-check bot added the new A new package submission. label Dec 27, 2025
@NaifAlsultan
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

Labels

new A new package submission.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant