---
title: >-
  WaqfTech Markdown Editor — Lightweight Markdown editor with auto-formatting
  for Islamic texts and typography — by Jad Madi (@jadmadi)
description: >-
  Web editor specifically engineered for Arabic and Islamic texts. Features
  automated formatting for Quranic verses (symbols and brackets ﴿ ﴾), Hadith
  quotation markers, classical honorific ligatures, and RTL paragraph styling.
href: /project/waqftech-markdown-editor/
author: Jad Madi
category: Islamic Tech & Waqf
domain: Islamic Tech & Waqf
status: Live Demo
license: WaqfDPL-Isnad 1.0
year: '2026'
---
# WaqfTech Markdown Editor — Lightweight Markdown editor with auto-formatting for Islamic texts and typography

Web editor specifically engineered for Arabic and Islamic texts. Features automated formatting for Quranic verses (symbols and brackets ﴿ ﴾), Hadith quotation markers, classical honorific ligatures, and RTL paragraph styling.

## Project Overview

- **Website**: https://jadmadi.net/project/waqftech-markdown-editor/
- **Live Platform**: https://markdown.waqf.dev
- **Repository**: https://github.com/WaqfTech/waqftech-markdown-editor
- **Documentation**: https://github.com/WaqfTech/waqftech-markdown-editor/blob/main/README.md
- **Package**: https://www.npmjs.com/package/@waqftech/markdown-editor
- **Domain**: Islamic Tech & Waqf
- **Category**: Islamic Tech & Waqf
- **Status**: Live Demo
- **Year**: 2026
- **License**: WaqfDPL-Isnad 1.0 (waqf)
- **Author**: [@JadMadi](https://x.com/jadmadi)

## Quick Install & Run

```bash
pnpm add @waqftech/markdown-editor
```

## The Problem It Solves

Standard markdown editors treat Arabic as plain bidirectional text, lacking native handling of Quranic punctuation, Aya numbering brackets, and classical Arabic ligature abbreviations.

## The Solution

An intelligent editor with text replacement rules that automatically normalizes Quranic brackets, Hadith quotation marks, and typography on typing.

## Key Features & Capabilities

- Two-row toolbar: standard markdown formatting plus dedicated Islamic text insertion
- Automatic conversion of verse syntax to classical ornamental brackets ﴿ ... ﴾ and Hadith quotes « ... »
- Guided surah and ayah search palette with autocomplete (/quran and \)
- Semantic tag transformation for structured <aya ref="..."> and <hadith grading="..."> blocks
- Direct insertion of Islamic honorific ligatures (ﷺ, ﷻ)
- Clean export to standard Markdown, HTML, and print-ready PDF

## Technical Specifications & Architecture

- **Languages**: TypeScript, React
- **Frameworks / Libraries**: React, Lucide Icons, Vite, Tailwind CSS
- **Architecture**: Client-side typography transforms, Lucide UI, and zero server persistence
- **License Model**: WaqfDPL-Isnad 1.0

## Frequently Asked Questions

### Can I use this component in React projects?

Yes. Install `@waqftech/markdown-editor` with `pnpm add @waqftech/markdown-editor` and import `<WaqfEditor />`.

## Links & References

- Project Page on Crosscurrent Code: https://jadmadi.net/project/waqftech-markdown-editor/
- Full Projects Directory: https://jadmadi.net/projects/
- Author Profile: https://jadmadi.net/about/