Welcome to the comprehensive documentation for the @muslims-community/quran package!
- Installation Guide - How to install and set up the package
- Quick Start - Basic usage examples and common patterns
- API Overview - Complete function reference
- Basic Functions - getAyah, getSurah, getQuranData
- Search Functions - searchText, searchBySurahName
- Random & Special - getRandomAyah, getSajdahAyat
- Range Reading - getAyahRange for reading apps
- Juz & Hizb - getJuz, getHizb for daily reading
- Statistics - getSurahStatistics for analytics
- TypeScript Integration - Complete TypeScript guide
- React Applications - Building React apps with the package
- Node.js Applications - Server-side usage patterns
- Performance Tips - Optimization strategies
- Data Structure - Understanding the Quran data format
- Juz & Hizb System - Islamic reading divisions explained
- Metadata Guide - Working with ayah and surah metadata
- Reading Apps - Build Quran reading applications
- Search & Discovery - Implement search functionality
- Educational Tools - Create learning applications
- Prayer Apps - Integrate with prayer applications
- Error Handling - Common errors and solutions
- Migration Guide - Upgrading between versions
- Contributing - How to contribute to the project
- Changelog - Version history and changes
- Daily Reading App: Juz & Hizb Guide
- Surah Study Tool: Range Reading Guide
- Search Implementation: Search Functions Guide
- Statistics Dashboard: Statistics Guide
- Random Ayah Display: Random & Special Guide
Looking for something specific? Check these resources:
- Function Reference: See API Overview
- Error Messages: Check Error Handling
- Examples: Browse Examples & Tutorials
- TypeScript Types: See TypeScript Guide
This package works across all JavaScript environments:
| Platform | Support | Guide |
|---|---|---|
| Node.js | ✅ Full | Node.js Guide |
| Browser | ✅ Full | Browser Guide |
| React | ✅ Full | React Guide |
| React Native | ✅ Full | React Native Guide |
| Vue.js | ✅ Full | Vue Guide |
| Angular | ✅ Full | Angular Guide |
| Version | Features | Documentation |
|---|---|---|
| 1.1.0 | Enhanced functions, Juz/Hizb, Statistics | Current |
| 1.0.x | Core functions, Basic search | Legacy Docs |
- Quick Questions: Check FAQ
- Bug Reports: GitHub Issues
- Feature Requests: GitHub Discussions
- Community: [Discord/Telegram] (coming soon)
This documentation is created with Islamic principles in mind:
- Accuracy: All information is verified and tested
- Clarity: Explanations are clear and comprehensive
- Respect: Content maintains the sanctity of Quranic text
- Community: Encourages collaboration and learning
Made with ❤️ by Muslims Community
"And We have certainly made the Qur'an easy for remembrance, so is there any who will remember?" - Al-Qamar 54:17