quran-search-engine

Quran Search Engine Documentation

Welcome to the official documentation for quran-search-engine, a stateless, UI-agnostic Quran search engine for Arabic text written in pure TypeScript.

Introduction

This library provides a deterministic and highly customizable search experience without being tied to any specific UI framework. You control the data, the UI rendering, and the persistence layer.

Core Features

• Arabic Normalization (cleaning text, removing tashkeel)
• Exact text matching
• Lemma & Root matching (via morphology and word maps)
• Regular Expression search with ReDoS safety validation
• Advanced Fuzzy fallback
• Computed highlight ranges (UI-agnostic)

---

📚 Table of Contents

Getting Started

• Project Description & Getting Started
• Installation Guide
• Quick Start

Guides

• Search Syntax & Scoring
• Advanced Configuration
• Examples & Integrations
• English-Arabic Search

Reference

• Architecture & Design Decisions
• Performance Aspects
• Phonetic Inverted Index Generation

API Reference

• Core API (search, load..., normalize...)
• Type Definitions
• Tokenizer & Matching Types
• Inverted Index & Data Strategy

Migration & Contributing

• Migration Guide
• Contribution Guide

---

Enjoy building fast and customizable Quran search experiences!

This site is open source. Improve this page.