tim-hub / obsidian-bible-reference

Take Bible Study notes easily in the popular note-taking app Obsidian, with automatic verse and reference suggestions.

Obsidian Bible Reference

• Simplify your Bible Study note-taking experience with the user-friendly Obsidian.md notes app.
• Experience the seamless assistance of automated Bible Verse suggestions for effortless referencing.

These will be very appreciate for the project development. 👍

• 👉 Star the Project
• ☕️ Buy me a coffee @Github Sponsor
• ❤️ Provide Feedback in Issues or join Discussion

---

About

How to use

1. Open a note in Obsidian.md application
2. In a note, for example type --John1:1
3. Select the suggestion

Read more about How to use

On iOS devices, there is a known issue about conflict between Smart Punctuation and double hyphens --.

To make it work, Smart Punctuation need to be turned off => How to use on iOS

Contribution and Credits

• All different kinds of contributions are welcom, see: How to Contribute
• Credits: Bible API/Data Source Providers

---

Sponsors and Contributors ✨

Thanks goes to these wonderful people (emoji key):

Chris Gonzales 💵 🤔	Jeremy Treis 💻 🐛 🤔	minermaniac447 💻	Brennen Puth 💻 🤔	Joey Kilgore 💻	Ben Vanderhoff 📖	Bill Chen 💻
GScriptS 💻 🌍	Aaron Friedel 💻	benjayahari 🌍	George 🌍	Nathan 💻	Karl Fischer 🌍	OfirSinn 🌍
Pavel Diatchenko 💻	Joshua Stoll 💻 🌍	blankton2 🌍

Special Thanks for the sponsors

• Chris Gonzales

obsidian-bible-reference's Issues

Books that start with numerals

Hello @tim-hub.

First of all, congratulations for the excellent plugin. It is essential for my Bible studies! 😉

I'm Brazilian, and I use the João Ferreira de Almeida version in the Obsidian Bible Reference settings. But when I need to insert some verse from books that start with a numbering, the plugin simply does not deliver any pop-up with the desired verse.

For example, 1 Timothy 6:10: I already tried with --1timoteo6:10, --Itimoteo6:10, --itimoteo6:10, --1 Timóteo 6:10, --I Timóteo 6:10, --i timóteo 6:10, --1Timóteo6:10, --ITimóteo6:10, --itimóteo6:10, --1 Timóteo 6.10, --1timoteo6.10, --1ti6:10, --1ti6.10, --1tim6:10, --1tim6.10, --Itim6.10, etc.

I also tried using the name of the book in English, and the result was the same: no reference. Both the Old and New Testament books, as long as they begin with a numeral, have no reference.

Is this a bug, or am I the one who doesn't know how to use the plugin correctly? 🤔

Would it also be possible to add a command accessible through Ctrl + P, where we can insert the desired book and verse so that the plugin pastes it in the position where the cursor is?

Regards,
Samej Spenser.

Not working properly on iPAD pro

It works fine on my MAC, but not working on my iPAD pro. Any idea? Thanks!

[Feature Request] Paste link along with Reference

Would be nice to be able to have an external link pasted with the reference and bible version once you tackle the other requests!

I dont know if you use macOs but there are alfred workflows that do this

Thank you for your hard work!

Ability to choose specific version

First of all thank you so much for this. I have looking for such a solution.

Would it be possible to be able to select a specific version when adding the bible verses?

And also be able to have the 2001 bible translation - https://2001translation.org/

Allow insertion of entire chapters at once

Is your feature request related to a problem? Please describe.
I occasionally have to pull in entire chapters at a time, and it's a bit inconvenient to have to look up the length of the chapter, then use --[Book][ch]:1-[last verse], especially since I know both APIs support full chapter grabs.

Describe the solution you'd like
Some way of pulling an entire chapter at once, instead of just individual verses. There are a few ways I can think to format this - the easiest would be, for example, "--John3". If there's a reason against doing that, though, you could do something more of the format "--John3:c" or "--John3:all". This would use the API endpoints https://bolls.life/get-text/[translation]/[book num]/[chapter num]/ or https://bible-api.com/[book name]%20[chapter num]?translation=[translation]

Describe alternatives you've considered
As said before, I presently can just look up the length of the chapter in verses and do that as the upper bound of the range, but it's an extra step and takes a lot longer - this would be a nice convenient alternative.

[Feature Request] Ideas for settings.

I'm using this plugin through BRAT and I'm loving it already. I realize it's in a state of development, but I wanted to suggest two things (which you may have already thought of).

1. Firstly, being able to pick version. I love the fact that you used NKJV, because that seems like a good, solid, middle of the ground version. However, I sometimes want a verse in a different version. I am not sure how you'd do this, but it's a suggestion.
2. Secondly, I'd like to be able to format my verse grab, much as other plugins do, e. g. Podcast notes and several others. I know this may take a lot of work, but being able to format the verse would be very nice.
   I do want to reiterate that I'm already loving this plugin and look forward to see where you take this. I appreciate all the hard work you've already put into it.
   Thank you.

New Living Translation and Message Version of the Bible

I appreciate the great work you are doing & definitely the world is getting better by your approach to life.
Kindly add these versions of the Bible: New Living Translation and the Message Bible.
Thank you Ma and Sir.

Extend the verse lookup command

I am thinking of instead of using verse lookup as command

maybe extend to bible book chapter verse to be more direct

Originally posted by @tim-hub in #78 (comment)

So that the flow will be like.

• CMD + P
• John1:1 or ESVJohn1:1

to get the verse,

instead of

• CMP + P
• Verse Lookup
• John1:1

Version

Requesting for your kind assistance with adding a vry popular version of the bible. The new world translationVersion.

[Feature] Formatting options

Amazing plugin! I would love to use it, however, I would really like to be able to alter the formatting a bit. Would it be possible to add options for splitting the verses to new lines as well as having the verse numbers?

Invalidate Modal On Query Change

The Problem

When typing a query, the results for the verse do not invalidate themselves when the query is added onto, producing incorrect citations if moving fast. This is frustrating to forget about, as it is not easy to delete large chunks of text when moving fast.

Example

Using the inline query, type --John1:1. Then quickly add -20 and press enter. This causes an incorrect citation (inserts John 1:1 instead of John 1:1-20), due to the amount of time it takes to make the network request.

Proposed Solution

Invalidate the suggester as soon as the query is added onto. If the query changes, the suggester should vanish or have no results until the next network request is complete.

Confusing trigger for Isaiah

Thanks very much for developing this plugin! I use it extensively in my sermon preparations.
One thing that I've encountered--and only now discovered the work-around--is that typing in --Isa triggers 1 Samuel instead of Isaiah. I just discovered that I can type in the --Isaiah, so there's no show-stopper here.
It's possible that documentation is the best resolution, although I don't use the Roman numeral designation myself (e.g, ICor/iCor instead of 1Cor). One other possible solution is to set this as a preference; something like:

Triggers for multiple books (e.g., Samuel and Chronicles):

• Arabic numerals
• Lower case Roman numerals
• Upper case Roman numerals

Again, not a show-stopper, but something to consider.

Adding more scripture API

I was able to make it work.

[Feature] Customize output

Thank you so much for your work on this. I do have a request. I'd like to be able to customize the output of the verses. I have a [!verse] callout that I'd like to be able to use. Also, I'd like the verse reference in the title of the callout. Thanks again!

No spacing between multiple verses

After I reference a range of verses (e.g. --matt20:1-16), and insert the suggested text, there is consistently no space between inserted verses. So the above reference using the ESV translation looks like this after selecting the suggestion:

> [!Bible] 
> “For the kingdom of heaven is like a master of a house who went out
> early in the morning to hire laborers for his vineyard.After agreeing with
> the laborers for a denarius  a day, he sent them into his vineyard. 
> 
  [matt 20:1-2 - ESV](https://bible-api-bff.bai.uno/bolls-life/ESV/40/20/)

Note the lack of spacing between vineyard and After.

The expected result would be to have a whitespace of some kind between each verse in the range.

Having back links

Hi,
I recently started to use Obsidian and found out about this plugin. Thank you so much for working on this.

Would it be possible to have a feature that lets you get backlinks of the verses or even the book itself.
So, for example, if I do --Matthew3:5, I get a link like the [[name]] and maybe the notes you write under the code block get copied to the link you created. It doesn't have to be a specific verse, it could be more generally the book of the Bible.

I would think it would be much more powerful if this plugin can use the well-known feature of Obsidian.

Just a thought.
Thank you!

Add German Bible translation

Hello everyone, first of all thanks for the plugin @tim-hub, its really helpfull. It would be even nicer if we could add a german bible translation. Is this possible?

Tagging bible chapters

From my current understanding of the plug-in, there is nothing within the project right now that allows for viewing how different notes may be linked (referencing the same books or chapters). I think there are 4 levels of tags that could be easily included (and I'll show an example of how for each):

1. A general #bible for all bible verses
2. A book specific tag (ex. #matthew for the Gospel of Matthew)
3. A chapter specific tag (ex. #matthew26 for the 26th chapter in the Gospel of Matthew)
4. A verse specific tag (ex. #matthew26_40 for the 40th verse in the 26th chapter in the Gospel of Matthew)

This could be done relatively unobtrusively on the same line that gives the link to the chapter online.

[!Bible] matthew 25:40 - ESV #bible #matthew #matthew26 #matthew26_40
⁴⁰ And the King will answer them, ‘Truly, I say to you, as you did it to one of the least of these my brothers, you did it to me.’

While being able to search for verses might be sufficient, this inclusion would provide a simple solution to easily view connections of notes containing verses in the graph view (by turning on the tags in the graph view).

Each of these 4 options could be a selection item in the Bible Reference settings, and when turning them on and off should go and adjust the tags in all notes containing the bible verses (allowing for people to turn them on to whatever level makes sense for their search in the graph view).
This last option of going back and modifying tags on all notes containing bible references might be something for later depending on the want from the community for this portion, but I believe the addition of the tags should be relatively straightforward (especially the #bible) while adding a sufficiently new and useful tool for seeing connected thoughts.

No space between sentences

I'm not sure if this is a feature or a bug. When the Bible reference appears, there are no spaces between sentences (e.g., This is Sentence One.This is Sentence Two). Is this a function of the API (Bolls)?

Thanks for a great plug-in,
Robert

或许能用得上

https://wdbible.app/1co.11.cunps
这里有很多中文圣经，不知道您是否可以和开发者联系获取API的事

Suggest books

Is your feature request related to a problem? Please describe.
Some of the books of the Bible are hard to spell.

Describe the solution you'd like
It would be nice if while typing the name of the book if the verse selector that shows the whole verse would pop up with just the name of the book.

Tipping Matt would show Matthew, and tapping it would then insert the whole word. Typing King would show 1 Kings and 2 Kings; typing Cor would show 1 Corinthians and 2 Corinthians.

Allow verse to be a footnote

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
Enable the verse to be appended to the footnote rather than inline with the verse. Obsidian has built-in footnote syntax.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Compatibility issues with Smart Typography Plugin

Thank you for all the work in creating this, as a Theology student, this plugin adds so much value to my note taking! There is an compatibility issue when using this alongside the smart typography plugin; one of the features in smart typography is that two dashes (--) into an "en-dash" which causes issues since you have to backspace in order to get two regular dashes, rendering the command to reference a verse impossible for some odd reason. Whenever I turn that plugin off, however, I can reference Scripture without any issue. It's not a pressing issue, but it would make for a quality of life improvement. Thanks again!

ESV API Support

If you aren't interested in taking this on, I might. There's an official English Standard Version API. Though not my 100% preferred translation, it's a reasonable one that I do sometimes read. It would require some setup to use, with the end user providing an API key.

It has lots of options, none of which conform to the open-bibles API. 😆 So it would be an entirely separate implementation.

iPad Support

Describe the bug
The plugin doesn’t appear to work on the iPad.
I type —John1:1 and nothing happens.

To Reproduce
Steps to reproduce the behavior:

1. Open new file
2. Type —1John1:1

Expected behavior
Expect verse suggestion to appear.

What Device Do You Use(please complete the following information):

• Device: iPad Pro
• OS: iPadOS
• Version 16.5.1

make book name translateable

Is your feature request related to a problem? Please describe.
currenlty you can only find a verse by it's english book name. will be very good if we can make it more generic based on available translateable? so people can contribute the book name on their own languages?

Plugin stopped working

I love the plugin and use it almost daily. Yesterday, I couldn't get it to work at all, and am still having the same issue today. Any ideas of what I can try?

Thanks in advance for any help :)

期待有中文版出现

我曾在社区看到你的这个插件受到启发，我自己把中文圣经转为MD格式临时用了一下但只能实现引用一节或一章的效果，看到你这插件可以自由选择从哪节到哪节非常羡慕，但我的能力有限实现不了，不知道我整理出来的66卷书的MD文件能不能派上用场，请你出一个中文版圣经的插件？

New callouts breaks multi-verse insertion

Recently I upgraded and while I love the look of the new Bible callout feature, it breaks multi-verse insertion on my translation (KJV).

If you need help on this, I'd be glad to try to help. I just need to dig in to figure out how this is working.

[Feature Request] Neovim/vim support

Hi,

I know that this is a long shot but I was wondering if you could create a neovim plugin that does the exact samething as this? I use neovim to edit my notes and obsidian to view because obsidian's vim shortcuts are not as robust.

Thank you!

Request whole chapter

Is your feature request related to a problem? Please describe.
There are times when I would like to print out the entire chapter or the rest of the chapter. The problem is that I don't necessarily know how many verses are in this chapter.

Describe the solution you'd like
It would be nice if passing 0 would select the whole chapter. So you could for example:

--Matthew17:0 - prints out full chapter (27 verses)
--Matthew17:17-0 - prints verses 17 through the end of the chapter (verse 17 - 17)

Describe alternatives you've considered

--Matthew17:full - prints out full chapter (27 verses)
--Matthew17:17-full - prints verses 17 through the end of the chapter (verse 17 - 17)

Create proper 429 request limit error response

The Problem

The error is unclear when this plugin hits a request limit.

Reproduction

Type --John1:1-3 in the editor, and then type a 0 at the end and delete it repeatedly. Eventually, the request will return a HTTP 429 status code, indicating it's hitting a rate limit. This is not shown to the user, however, and simply causes the suggester to stop updating.

Proposed Solution

Return the error in some way to the user - either by a notification popup or by replacing the content in the suggester with something relevant.

reflect two issues 反映两个问题

The Chinese version is only in traditional Chinese, which is not suitable for users in mainland China. I hope to have a simplified version soon.
The Chinese version currently has spaces between each Chinese character, please delete

中文版只有繁体中文，不适合**大陆用户。我希望尽快有一个简化版本。
中文版目前每个汉字之间有空格，请删除

Allow the Callout Link to be to the actual bible verse/chapter rather than the API call

Is your feature request related to a problem? Please describe.

I was expecting the scripture reference would link to the Bible scripture rather than the JSON request made. Often, with scripture references, it would be nice to be able to read the scriptures around it. So if the link would lead me back to the chapter/verse in an online bible that would be really helpful.

Potentially an even "cooler" option is a tooltip preview of the verse and the chapter around it (since we already get that from the Bolls Life API).

Describe the solution you'd like

I would like the link to the scripture to take me to an online bible where the book and chapter (and potentially verse) is selected.
Looking at the link info, specifically for the Bolls Life API, we can navigate directly to the chapter in it's online view by changing the link information from

[!Bible] [john 10:10 - ESV](https://bolls.life/get-text/ESV/43/10/)

to the following and removing the get-text route.

[!Bible] [john 10:10 - ESV](https://bolls.life/ESV/43/10/)

Describe alternatives you've considered

As briefly mentioned, potentially instead of a link, we could also display a tooltip with the chapter (potentially with the verse(s) in bold).

Additional context

Editable Prefix

Would it be possible to add an option to make the -- prefix editable?

Currently, this is conflicting with a plugin I have which replaces the -- with an em-dash.

Thanks for your contribution!

[Feature] Add daily note

Hi there! Awesome plugin, I love it. Could it be possible to combine this with templates/templater plugin so that random daily notes can be added to daily notes for example? I think it would be nice.

Also looking forward to have spanish language as well!

Thanks

chapter import

Sometimes I want to import an entire chapter.

At the moment I need to look up how many verses are in the chapter Genesis1:1-?

It would be nice if the syntax "Genesis1" or "Genesis1::" or something similar brought up the whole chapter automatically.

Put reference at top

• maybe build a setting for it

Polish vesion bible

Hello. Thanks for the plugin. Have you thought about the Polish version? I've seen the Polish version in the Bolls Bible https://bolls.life/BW/1/1/

Allows multiple bibleVersion

Would you consider allowing multiple bibleVersions?

E.g. selecting cuv, esv which will convert the same reference to both translation at the same time.

Problem with duplicate books and books that contain only one chapter

How I use duplicate books such as 1 and 2 Corinthians or 1 and 2 Kings and books that contain only one chapter, such as Jude? I Use Portuguese version - Almeida: João Ferreira de Almeida
@tim-hub

Does not work on mobile

https://github.com/tim-hub/obsidian-bible-reference/blob/master/manifest.json#L9 seems to indicate that it would work on mobile, but when testing it on iPad and iPhone, it doesn't seem to work. Any idea? Thanks.

add indonesian bible

hi, thankyou for the plugin. have you consider to add another bible version? i would love to have indonesia bible included. i can open pr too.

ESV Proverbs do not import correctly

Import a block of proverbs.

Only the first two lines are included in the block.

*update - actually I think it is the default English Word Bible and not ESV

Verse of the day syntax

I would like to be able to generate a verse of the day in the top of my daily note using templator.

I feature allowing this would be really neat

Add the option to format the text in Markdown rather than HTML

The option to have the text formatted using markdown would help the uniformity across multiple notes. This also helps the text render properly when opened in other markdown editors.

At the moment, I wait for the plug-in to populate the text, and then I reformat manually. For example I change <sup> **16** </sup> to **$^{16}$**

This is a bigger ask, but the ability to customize the callout that is created would also be appreciated. I have a custom “Verse” callout I use, and at the moment I reformat the output to conform.

Conflict with icon shortcodes

Because both your plugin and icon shortcodes are waiting on a : character (I think that's the conflict anyway), I can't get this to work with both enabled at the same time. Would be excellent to be able to insert a verse/passage using a command from the palette.

We should have a bare bone verse block formatting option for users. (Minimal version)

Discussed in #72

^{Originally posted by ajrty33 January 6, 2023}
I have been modifying src/VerseSuggesting.ts to create a minimal version. When taking notes in class with a lot of Scripture references, it's nice to have a bare bones verse without anything else. I would love to create a pull request for this, but creating the settings to make this an option is above my head.

---

• update setting page to organise the setting better, maybe have some screenshot/tutorial gif to show people how settings work
• investigate bare bone verse block, maybe use it as default setting

Check bible-api.com or re-host or proxy it

Thanks for the feedback.

One bible api provider was blocked. from bible-api.com

NIV: New International Version, 1984 (Bolls Life)
NKJV: New King James Version (Bolls Life)
CUV: China Union Version (Bolls Life)
ESV

These 4 versions suppose to work.

---

I will have a look of bible-api.com,

I might need to re-host this api, or build a proxy for it to make it work again.

Originally posted by @tim-hub in #9 (reply in thread)

Support for Deuterocanon

Is your feature request related to a problem? Please describe.
Firstly, can I thank you for this brilliant plugin. It has been really good helping me move over from Joplin. However as a Catholic, I am missing 7 books from my Bible! I am using the NRSV Catholic Edition version and I am still unable to fetch text from the book of Judith, the books of the Maccabees, Wisdom, etc. (however may I thank you again for including the NRSV? Thank you!)

Describe the solution you'd like
I would like the deuterocanonical books ('apocrypha') to be available. The ecumenical edition of the NRSV for example includes the following books variously used by Catholics and orthodox, some by different groups of orthodox only:

• 1 Esdras
• 2 Esdras
• 1 Maccabees
• 2 Maccabees
• 3 Maccabees
• 4 Maccabees
• Additions to Daniel
• Additions to Esther
• Baruch
• Judith
• Letter of Jeremiah
• Prayer of Manasseh
• Psalm 151
• Sirach
• Tobit
• Wisdom

Describe alternatives you've considered
(Not relevant)

Additional context
The NRSVCE does include some of these books if you look on some websites, but I would be keen to see the NRSV Ecumenical Edition so we could access the Orthodox books also (sometimes just the regular NRSV includes the Orthodox books, as on BibleGateway.com).

Once again, thank you for such a great and useful plugin.