obsidian-plugin/ramysami_obsidian-quran-plugin
1
0
Fork 0
mirror of https://github.com/ramysami/obsidian-quran-plugin.git synced 2026-07-22 13:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
19 commits 2 branches 6 tags 777 KiB
TypeScript 72.9%
JavaScript 24.8%
CSS 2.3%
Find a file
Ramy 552ec88e92
update readme
2026-04-25 14:39:46 +03:00
.github/workflows update release workflow to use release action v3 2026-04-22 02:00:22 +02:00
src Revert "implement usage of Quranic font (#1)" 2026-04-21 14:10:51 +02:00
.editorconfig init 2026-04-17 19:14:42 +02:00
.gitignore init 2026-04-17 19:14:42 +02:00
.npmrc init 2026-04-17 19:14:42 +02:00
AGENTS.md init 2026-04-17 19:14:42 +02:00
demo.gif updated README.md, manifest and LICENSE 2026-04-18 00:50:33 +02:00
esbuild.config.mjs init 2026-04-17 19:14:42 +02:00
eslint.config.mts init 2026-04-17 19:14:42 +02:00
LICENSE testing release workflow 2026-04-22 00:20:30 +02:00
manifest.json chore: bump version to 1.2.2 [skip ci] 2026-04-21 22:27:52 +00:00
package-lock.json chore: bump version to 1.2.2 [skip ci] 2026-04-21 22:27:52 +00:00
package.json chore: bump version to 1.2.2 [skip ci] 2026-04-21 22:27:52 +00:00
README.md update readme 2026-04-25 14:39:46 +03:00
skills-lock.json init 2026-04-17 19:14:42 +02:00
styles.css Revert "implement usage of Quranic font (#1)" 2026-04-21 14:10:51 +02:00
tsconfig.json init 2026-04-17 19:14:42 +02:00
version-bump.mjs init 2026-04-17 19:14:42 +02:00
versions.json chore: bump version to 1.2.2 [skip ci] 2026-04-21 22:27:52 +00:00

README.md

Obsidian Quran Inserter Plugin

An Obsidian plugin that allows you to quickly fetch and insert Quranic verses directly into your Markdown notes using the Al Quran Cloud API.

Features

  • Quick Insert: Search for any verse using the standard surah:verse format (e.g., 2:255 for Ayat al-Kursi).
  • Command Palette Support: Trigger the "Insert verse" command using Ctrl/Cmd + P.
  • Hotkey Support: Trigger the "Insert verse" command using a hotkey.
  • Smart Placement: Inserts text at your current cursor position, handling line breaks automatically.

Showcase

demo

How to Use

  1. Click the Book Icon in the ribbon or use the command palette (Ctrl/Cmd + P) and search for Insert verse.
  2. A modal will appear asking for the verse reference.
  3. Enter the reference in surah:verse format (e.g., 18:10).
  4. Press Enter or click Insert.
  5. The verse will be fetched and inserted into your current note.

Installation

From Community Plugins (Recommended)

Pending addition to the Obsidian Community Plugins list.

From BRAT (Beta Reviewer's Auto-update Tool)

  1. Install the BRAT plugin from the Community Plugins gallery.
  2. Open BRAT settings: Settings > Community plugins > BRAT.
  3. Click Add Beta plugin.
  4. Paste the repository URL: https://github.com/ramysami/obsidian-quran-plugin
  5. Click Add Plugin.
  6. Enable the plugin in Settings > Community plugins.

Manual Installation

  1. Download main.js, manifest.json & style.css from the latest release.
  2. Create a folder named quran-inserter in your vault's .obsidian/plugins/ directory.
  3. Move the downloaded files into that folder.
  4. Reload Obsidian and enable the plugin in Settings > Community plugins.

Development

If you want to build the plugin yourself:

  1. Clone this repository.
  2. Run npm install to install dependencies.
  3. Run npm run dev to start the build process in watch mode or npm run build to build the plugin.

Planned features

  • Insert tafsir/translation.
  • Insert multiple verses.
  • Link to the verse on Quran.com.
  • Settings page.

Note: This plugin requires an active internet connection to fetch verses from the Al Quran Cloud API.

Inspired by Malik Safwan.