Skip to content

hakkm/obsidian-quran-helper-plugin

 
 

Repository files navigation

Quran Helper Plugin

An Obsidian plugin that helps you select and insert Ayahs (verses) from the Quran into your Obsidian notes. Inserted Ayahs are added to a quote callout by default.

finding a Surah

Selecting Ayah Rendered Ayah Command Palette Fuzzy Search (fzf)
finding an Ayah rendering the Ayah the rendered ayah fzf search

Features

  • Insert Ayahs directly into your notes.
  • Fuzzy search for Surah names or Ayah content.
  • No internet connection required.

Installation

You can install it directly from the community plugins.

  1. Open the Obsidian settings.
  2. Navigate to Community plugins.
  3. Search for Quran Helper.
  4. Click Install and then Enable.

Usage

  • Open the Quran modal by clicking the book icon in the ribbon or selecting the Insert Ayah command from the Command Palette.
  • In the modal, choose the Surah by name or number.
  • Browse or fuzzy search for the desired Ayah.

Tip on Searching

When searching for a Surah or an Ayah (verse), you can type part of the number or content of that Surah or Ayah, it doesn't have to be from the beginning.

For example:

  • Type 11 when searching for Surah Al-Nas (numbered 114).
  • Type a few characters from the Surah name (e.g., النا) to filter the list.

This plugin differs from the Quran Lookup plugin in several ways:

  • Does not require Surah:Ayah format.
  • Does not require an internet connection.
  • Allows for fuzzy searching of Surah names or Ayah content.

Credits

The plugin uses the quran-json.

About

Obsidian plugin to find and insert any Quran Ayah (verse) in your notes

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 77.0%
  • JavaScript 23.0%