Skip to content

Commit

Permalink
update readme and capitalize Quran
Browse files Browse the repository at this point in the history
  • Loading branch information
MKSherbini committed Jun 12, 2024
1 parent ef18d3f commit 3bef498
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ After enabling the plugin in the settings menu, you should see the added command
## Features

- commands:
- `Noor: Random quran quote`: inserts a quote block at the current editor location containing a random verse with recitation
- `Noor: Random Quran quote`: inserts a quote block at the current editor location containing a random verse with recitation
- scripting:
- `noorJS.randomQuranQuote()`: this function returns a quote block containing a random verse with recitation


## Integration with other plugins

obsidian plugins compliment each others, here are some ideas
- **with [templater](https://github.com/SilentVoid13/Templater)**: use `<% noorJS.randomQuranQuote() %>` to insert the quran quote into your notes (like the daily note to get a daily verse)
- **with [commander](https://github.com/phibr0/obsidian-commander)**: use it to create a button for the `Noor: Random quran quote` command
obsidian plugins complement each other, here are some ideas
- **with [templater](https://github.com/SilentVoid13/Templater)**: use `<% noorJS.randomQuranQuote() %>` to insert the Quran quote into your notes (like the daily note to get a daily verse)
- **with [commander](https://github.com/phibr0/obsidian-commander)**: use it to create a button for the `Noor: Random Quran quote` command


## Settings

- **Reciter**: choose your favorite reciter from the drop down menu
- **Translation Language**: choose the second language to show next to arabic
- **Reciter**: choose your favorite reciter from the drop-down menu
- **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**


Expand All @@ -46,3 +46,7 @@ obsidian plugins compliment each others, here are some ideas

The Quran verses are retrieved from
- [alquran.cloud](https://alquran.cloud/api): An opensource Quran API made by the [Islamic Network](https://islamic.network/) ([github](https://github.com/islamic-network)) and respective [contributors](https://alquran.cloud/contributors).


## Contributions and suggestions
Please feel free to open a [pull request](https://github.com/MKSherbini/obsidian-noor/pulls) with suggested improvements and new feature requests
2 changes: 1 addition & 1 deletion main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export default class NoorPlugin extends Plugin {
// This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
id: 'random-quran-quote',
name: 'Random quran quote',
name: 'Random Quran quote',
editorCallback: async (editor: Editor, view: MarkdownView) => {
editor.setSelection({line: editor.getCursor().line, ch: editor.getCursor().ch});
if (editor.getCursor().ch > 1)
Expand Down

0 comments on commit 3bef498

Please sign in to comment.