LDS Scriptures Reference Plugin for Obsidian

Easily insert your favorite scripture verses in Obsidian!

---

Table of Contents

• Features
• Quickstart
• Book Names Reference
• Local Book Installation
• Development

---

Features

Reference Verse

Insert a callout to a verse using this syntax: +<Book Name> <Chapter Number>:<Verse Number>

Example:

Inserted Callout Example:

Reference Range

You can also insert a callout to a range of verses using this syntax: +<Book Name> <Chapter Number>:<Verse Start>-<Verse End>

Example:

Inserted Callout Example:

Multiple Language Support

Currently, the following translations are available:

• deu - German,
• eng - English,
• jpn - 日本語,
• kor - 한국어,
• spa - Español,

If you would like to use other translations, please feel free to submit an issue to the translations repository.

Multiple Scriptures Support

The standard works, or the volumes of scripture officially accepted by the Church of Jesus Christ, Latter Day Saints, are available.

• Holy Bible (King James Version)
• Book of Mormon
• Doctrine and Covenants
• Pearl of Great Price

Quickstart

Requirements

You only need Obsidian installed!

Installation

Community Plugin

This plugin can be found from the list of community plugins for Obsidian. Open Obsidian's Settings > Community Plugins, and click Browse to search this plugin's name and install.

Manual Installation

The plugin can also be manually installed by:

1. Creating a directory called lds-scriptures-reference under .obsidian/plugins of your vault
2. From this plugin's Releases Page, download and put main.js, manifest.json, styles.css into .obsidian/plugins/lds-scriptures-reference
3. Reload Obsidian and navigate to the Community Plugins tab to see that installation is successful

Book Names Reference

The list of book names, used in this plugin can be referenced on this page

Local Book Installation

Currently, there are no solid options for retrieving verses from LDS scriptures using an API, except the Holy Bible. Therefore this plugin stores scripture data locally. The English translation is 14MB in size, but please note that size may vary between translations.

This plugin utilizes env-paths under the hood to resolve the translation data directory. Depending on your platform, the translations will be stored in a different location.

• For Windows: C:\Users\<USERNAME>\AppData\Roaming\lds-scriptures-reference\Config\translations
• For macos: ~/Library/Preferences/lds-scriptures-reference/translations
• For linux: $XDG_CONFIG_HOME/lds-scriptures-reference/translations

Also note that since there are 100+ official translations of these scriptures, the scriptures data are NOT included in the plugin itself, but lazily installed as you select your language in the plugin preferences tab.

Development

Build

Install dependencies:

$ yarn

Run build script:

$ yarn build

3 files will be created in the root directory: main.js, manifest.json, styles.css

Versioning

This plugin follows semver.

To publish a new release, tag it with git tag -a <major.minor.patch> -m <message>