Linked Quran
Ulvi2 downloadsSync your notes with linkedquran.com and read surah pages with the site's verse cards, translation tabs and study layers.
- Overview
- Scorecard
- Updates1
Read and study the Quran in your Obsidian vault the way you do on linkedquran.com: each verse as a card with your own note, translation tabs, word by word, and the site's study layers (related verses, rulings, topics, prayers and more). Notes you publish sync with your account on the site; drafts stay in your vault.
What it does
- Shows Linked Quran surah pages as verse cards: your note inside the verse box, a Publish button,
translation tabs, and
/2:255to insert a verse. - Draws the site's public layers under each verse; the buttons in the Layers box turn them on and off.
- Syncs the notes you publish with linkedquran.com both ways. With your key you can also agree, report, vote and suggest from the layers, as on the site.
- Refresh site text rewrites the Arabic, word by word and translations on your surah pages from the site without touching your notes; Add surah… adds a surah that isn't in your vault yet.
- A surah navigator in the left sidebar.
Account
Surah pages come from your linkedquran.com account: download your vault (or add surahs) after signing in, and paste the sync key from linkedquran.com/hesap → Sync into the plugin settings. Syncing, publishing, actions on layers, Refresh site text and Add surah… all need the key. Without a key the plugin only draws the site's public layers on surah pages already in your vault.
Installation
- In Obsidian, open Settings → Community plugins and turn off restricted mode.
- Select Browse, search for Linked Quran, install and enable it.
- Paste your sync key into Settings → Linked Quran.
Manual install: copy main.js, manifest.json and styles.css from the latest release into
<vault>/.obsidian/plugins/linkedquran/, then enable the plugin. Requires Obsidian 1.8.7 or newer.
Network use
Every request goes to the site address in the plugin settings (default https://linkedquran.com).
There is no telemetry and no other server.
| Request | Key | What is sent | Why |
|---|---|---|---|
POST /api/kasa-senkron |
yes | Only the Publish area of each Linked Quran surah page (with its path and sync state); drafts and other files are never sent | Sync published notes both ways |
GET /api/lq/v1/kasa/{surah} |
yes | Surah number, the text you chose in the settings (translations, word by word, Arabic) and the neighbouring surahs in your vault | Refresh site text, Add surah |
POST /api/lq/v1/eylem |
yes | The action (agree, report, vote, suggest), the layer item it is about, and any reason or note you type into it | Actions on layers |
GET /api/lq/v1/en/{surah} |
no | Surah number only | The site's public layers |
GET /kuran/dizin.json |
no | Nothing | Translation catalog for the settings |
GET /kuran/kelime/{surah}.json |
no | Nothing | The words of a verse, for the suggestion form |
GET /obsidian/linkedquran/linkedquran.css |
no | Nothing | On startup, if your vault has the linkedquran.css snippet, it is updated to the site's current copy; your two size values are kept and the old file is saved as linkedquran.css.bak |
The plugin writes only inside your vault: Linked Quran surah pages (and, with Add surah… in an empty vault, the Linked Quran/Surahs folder with its index files) and, as above, .obsidian/snippets/linkedquran.css. Pending actions and per-device timestamps are kept in Obsidian's local storage on that device.
Privacy policy: linkedquran.com/datenschutz.
Source
This repository holds the released plugin files. The plugin is plain JavaScript without a build step; main.js
is the source.