naifs-islamic-research-toolkit:0.1.0

[NaifAlsultan]

I am submitting

• a new package
• an update for a package

Description:

naifs-islamic-research-toolkit 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

[NaifAlsultan]

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!

[saecki]

Thanks for this package! I've left a comment regarding the name.

[saecki]

This name seems a little too obvious. We try to avoid canonical names so multiple packages serving the same purpose can coexist without an unfair advantage. See: https://github.com/typst/packages/blob/main/docs/manifest.md#naming-rules

[NaifAlsultan]

I changed the name from madinah-mushaf to madinah-mushaf-cite. Does that name comply with the rules?

[saecki]

Please correct me if I'm wrong, but from my understanding the "madinah/medina mushaf" is a specific copy of the Quran right? That would make this a canonical name for what this package does, and adding -cite only specifies the function a bit more. Instead what the naming rules are trying to enforce, is that a package name is not a strict description of the function of a package, but also includes some non-descriptive (sometimes playful) parts. For example slitastic instead of slides, or modern-cv instead of just cv.

[NaifAlsultan]

Alright, that should do it. I renamed it to naifs-islamic-research-toolkit (prefixed with my name).

Thanks for taking the time to review!