No description
Find a file
2025-05-14 14:25:54 -04:00
src Fixes up live preview 2025-05-14 14:24:56 -04:00
.editorconfig Initial commit 2025-03-09 16:39:43 -04:00
.eslintignore Initial commit 2025-03-09 16:39:43 -04:00
.eslintrc Initial commit 2025-03-09 16:39:43 -04:00
.gitignore Add Bible chapter navigation and enhance rendering 2025-03-10 12:00:02 -04:00
.npmrc Initial commit 2025-03-09 16:39:43 -04:00
CHANGELOG..md Prepares for 0.6.0 release 2025-05-14 14:25:54 -04:00
esbuild.config.mjs Refactor plugin architecture and remove legacy code 2025-03-09 22:32:41 -04:00
LICENSE Adds license 2025-03-11 21:43:01 -04:00
main.ts Formatting 2025-04-24 16:38:23 -04:00
manifest.json Prepares for 0.6.0 release 2025-05-14 14:25:54 -04:00
package-lock.json Base implementation 2025-03-09 17:32:32 -04:00
package.json cleanup 2025-03-09 20:52:05 -04:00
preview.png Updates readme 2025-03-11 22:03:59 -04:00
README.md Adds better handling of inline bible references 2025-03-15 16:17:05 -04:00
styles.css Major internal cleanup 2025-05-01 20:40:22 -04:00
tsconfig.json Refactor plugin architecture and remove legacy code 2025-03-09 22:32:41 -04:00
version-bump.mjs Initial commit 2025-03-09 16:39:43 -04:00
versions.json Initial commit 2025-03-09 16:39:43 -04:00

Disciples Journal - Bible Verse Reference Plugin for Obsidian

This plugin enhances your Bible study and journaling in Obsidian by rendering Bible verse references and passages directly in your notes.

preview

Features

Inline Verse References

Type a Bible reference in an inline code block:

`Genesis 1:1`

The plugin transforms it into a reference with enhanced features:

  • Hover over the reference to see a popup with the verse text
  • The popup remains visible even when you move your cursor onto it
  • Click the reference inside the popup's heading to open or create a chapter note, which automatically scrolls to the verse

Full Passage Rendering

For longer passages, use a code block with the "bible" language specifier:

```bible
Genesis 1:1-10
```

This renders the entire passage directly in your note.

Enhanced ESV HTML Format

The plugin supports ESV's HTML formatted passages with:

  • Proper typesetting for poetic passages
  • Section headings
  • Footnotes and cross-references
  • Special formatting (like Words of Christ)

Download on Demand

With an ESV API token, the plugin automatically downloads Bible passages:

  • Enter your ESV API token in settings
  • Enable "Download on Demand"
  • Referenced passages are downloaded automatically
  • Downloaded content is saved locally for future use

Organized Content Structure

Bible content is saved in an organized folder structure:

Bible/ESV/
  ├── Genesis/
  │   ├── Genesis 1.md
  │   ├── Genesis 2.md
  │   └── ...
  ├── Exodus/
  │   ├── Exodus 1.md
  │   └── ...
  └── ...

You can customize this path in settings.

Supported Reference Formats

The plugin supports various Bible reference formats:

  • Single verses: Genesis 1:1, John 3:16
  • Verse ranges: Genesis 1:1-10, John 3:16-18
  • Entire chapters: Genesis 1, Psalm 23
  • Multi-chapter passages: Matthew 5:3-7:29
  • Books with spaces: 1 Corinthians 13:4-7, Song of Solomon 2:1

Settings

Access plugin settings in Settings → Disciples Journal:

  • Display Settings:

    • Toggle inline verse and full passage rendering
    • Customize verse font size
  • Bible Version Settings:

    • Currently supports English Standard Version (ESV)
  • Bible Content Vault Path:

    • Specify where chapter files are saved (default: Bible/ESV)
  • ESV API Settings:

    • Enter your token from api.esv.org
    • Enable/disable automatic downloading

Installation

From Obsidian Community Plugins

  1. In Obsidian, go to Settings → Community plugins → Browse
  2. Search for "Disciples Journal"
  3. Click Install, then Enable

Manual Installation

  1. Download the latest release from the releases page
  2. Extract to your Obsidian plugins folder: .obsidian/plugins/
  3. Enable the plugin in Obsidian's community plugins settings

Getting an ESV API Token

To use download-on-demand:

  1. Go to api.esv.org and create an account
  2. Log in and create a new API key
  3. Copy the token and paste it into the plugin settings

Scripture quotations marked "ESV" are from the ESV® Bible (The Holy Bible, English Standard Version®), copyright © 2001 by Crossway, a publishing ministry of Good News Publishers. Used by permission. All rights reserved.

Feedback and Contributions

For issues or suggestions, please open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.