From 3fc78a9ebcb70aa2c84e8ae9b93d4984c27efe48 Mon Sep 17 00:00:00 2001 From: Caleb Campbell <109765584+camelChief@users.noreply.github.com> Date: Wed, 16 Oct 2024 06:24:35 +1100 Subject: [PATCH] Update README.md --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f9ab5e6..e0859b4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,73 @@ -# local-bible-ref -Quickly and easily reference Bible verses stored locally in your Obsidian vault. +# Local Bible Ref + +Quickly and easily reference Bible passages stored locally in your Obsidian vault. + +## Basics + +### Inspiration + +This plugin takes heavy inspiration from the [Bible Reference](https://github.com/tim-hub/obsidian-bible-reference) and [Bible Linker](https://github.com/kuchejak/obsidian-bible-linker-plugin) plugins - please check them out! I've been using the *Bible Reference* plugin for a while (which has been great) and I love the simplicity of referencing passages using the `--` prefix. I also loved the idea of storing a Bible locally because then I could reference Bible passages even when I'm offline, as well as use my vault Bible for reading. Unfortunately, the markdown format of the *Bible Linker* local Bible is not great for reading, and I prefer the simplicity of using the `--` prefix to fetch Bible passages. There's also some referencing limitations in the *Bible Reference* plugin and occasionally some odd additions to passages returned from the [Boll's Life](https://bolls.life/) API. So, this is an amalgamation of those two plugins. + +### Getting Started + +To start with, you will need to create a Bible in your own vault. Some instructions on this can be found [[4. Projects/Local Bible Ref README#Bible Markdown Format|below]] (this plugin uses a different markdown format to *Bible Linker*). Once you've done that, open up the *Local Bible Ref* settings and fill out the *Bibles Path* and *Default Version Shorthand* fields. Then, to use the plugin, simply open a new note and use the `--` reference prefix to grab a passage of scripture. There are also additional options (similar to terminal command options) you can provide to the reference to indicate which version to use and what markdown format to display the passage in. More information can be found [[4. Projects/Local Bible Ref README#Usage|below]]. + +![[localBibleRef.gif]] + +## Usage + +### References + +In order to fetch a Bible passage, simply type in a Bible reference prefixed with `--`: `--John 1:1`. *Local Bible Ref* currently supports Bible references in the form: + +- Single verse: `--gen1:1` +- Multi verse: `--gen1:1-3` +- Single chapter: `--gen1` +- Multi chapter: `--gen1-3` +- Multi chapter & verse: `--gen1:3-3:9` + +The referencing syntax also allows for a lot of flexibility: + +- Short and full name references: `--gen1` + `--genesis1` +- Lowercase, uppercase and mixed-case references: ``--gEnEsis1`` +- Spacing (not more than a single space): `-- Genesis 1:1 - 2:2` + +### Options + +Local Bible Ref also all![localBibleRef](https://github.com/user-attachments/assets/5904e42c-790e-4d11-9f00-e2ce8c81097c) +ows you to provide a few options to a reference to specify which version you would like to use as well as what markdown format to use. Add an option to a reference by adding a `+` followed by the option (in any order): `--gen1:1-5+v:esv` + +Syntax: `--[+