Obsidian Stats logoObsidian Stats

Noor

by MKSherbini
5
4
3
2
1
Score: 41/100
Install Code

Description

Category: Learning & Knowledge Management
#quran#hadith#islam

The Noor plugin enriches the Obsidian experience by integrating Islamic teachings, including the Quran, Hadith, and Sunnah, into their note-taking workflow. It allows users to insert random Quran verses or Hadith quotes directly into their notes, complete with translations, recitations, and hyperlinks for further reading. The plugin also facilitates the creation of a Dhikr file, combining both a Quran and a Hadith quote for daily reflection. Customization options include selecting preferred reciters, translations, and languages.

Reviews

No reviews yet.

Stats

12
stars
795
downloads
3
forks
703
days
567
days
567
days
2
total PRs
0
open PRs
2
closed PRs
0
merged PRs
3
total issues
2
open issues
1
closed issues
26
commits

Latest Version

0.0.6
2 years ago

Changelog

Hadith: fix double endline formatting

See all version on GitHub

README file from

Github

Obsidian Noor Plugin

Noor is a plugin for Obsidian.md. It aims to help Muslims stay enlightened with Islam, Quran, Hadith, and Sunnah

Watch the video

Features

  • Insert a Quran Quote at the current location containing a random verse with recitation in Arabic, chosen translation language, and a hyperlink for more info.
  • Insert a Hadith Quote at the current location containing a random hadith in the chosen language and a hyperlink for more info.
  • Create a Dhikr file at the configured location containing a Quran Quote and a Hadith Quote (can be used again to update file with new quotes)

Usage

After enabling the plugin in the settings menu, you should see the added commands and the noorJS object.

  • commands:
    • Noor: Random Quran quote: inserts a quote block at the current editor location containing a Quran Quote
    • Noor: Random Hadith quote: inserts a quote block at the current editor location containing a Hadith Quote
    • Noor: Open Dhikr file: creates a Dhikr file at the configured location containing a Quran Quote and a Hadith Quote then opens in current view
    • Noor: Open Dhikr file popup: creates a Dhikr file at the configured location containing a Quran Quote and a Hadith Quote then opens in popup window view
  • scripting:
    • noorJS.randomQuranQuote(): this function returns a Quran Quote
    • noorJS.randomHadithQuote(): this function returns a Hadith Quote

Integration with other plugins

obsidian plugins complement each other, here are some ideas

  • with templater: use <% noorJS.randomQuranQuote() %> to insert the Quran quote into your notes (like the daily note to get a daily verse)
  • with commander: use it to create a button for the Noor: Random Quran quote command

Settings

General settings

  • Dhikr file path: configure where to create the Dhikr file

Quran settings

  • Reciter: choose your favorite reciter from the drop-down menu
  • Show translation: choose Arabic only or dual language mode
  • Translation Language: choose the second language to show next to Arabic
  • Translation Options: choose your favorite translation from the ones available in selected Translation Language

Hadith settings

  • Hadith language: choose your preferred language to show the hadith in.

Manually installing the plugin

  • Copy over main.js, manifest.json to your vault .obsidian/plugins/noor/.
  • Reload Obsidian to load the new version of your plugin.
  • Enable the plugin in the settings window.

Attributions

AlQuran Cloud APIs

The Quran verses are retrieved from

Hadith Encyclopedia APIs

The Hadith quotes are retrieved from

Contributions and suggestions

Please feel free to open a pull request with suggested improvements and new feature requests

Sponsors