search

aygjiay / obsidian-link-to-verse

MIT License
3 stars 0 forks source link

readme

📖 Link to Verse Plugin for Obsidian

Release Issues License

Easily create links to Bible passages in your Obsidian notes using any online Bible tool.

Demo

✨ Features

🛠 Installation

From Obsidian Plugin Marketplace

  1. Open Obsidian.
  2. Navigate to Settings > Community plugins.
  3. Click on Browse and search for Link to Verse.
  4. Click Install and then Enable.

Manual Installation

  1. Download the latest release from the Releases page.
  2. Extract the contents of the zip file to your Obsidian plugins folder: <vault>/.obsidian/plugins/obsidian-link-to-verse.
  3. Enable the plugin in Obsidian via Settings > Community plugins.

🚀 Usage

  1. Open any Markdown note in Obsidian.
  2. Select a Bible reference (e.g., John 3:16) from your note.
  3. Press Ctrl+P (or Cmd+P on Mac) to open the command palette.
  4. Type Create link to Bible and select the command.
  5. Your Bible reference will be replaced by a link to the passage in your note.

⚙️ Configuration

You can configure the plugin settings to fit your preferences:

Default Version

Specify your preferred default Bible version.

Link Template

Define the template for the URL linking to the Bible passage. The template should include a {{verse}} placeholder and optionally a {{version}} placeholder.

Setting Configuration

  1. Go to Settings > Community plugins > Link to Verse > Options.
  2. Enter your preferred Bible language (used to recognize book names and some abbreviations) (currently supported: sp, en).
  3. Enter your preferred default Bible version (e.g., NLT).
  4. Enable the use of + instead of URL-encoded spaces.
  5. Enable book name validation against an internal dictionary and use the defined book name.
  6. Set the link template to your desired format (e.g., https://www.biblegateway.com/passage/?search={{verse}}&version={{version}}).

Supported Tokens in Link Template

Two template types are currently supported:

  1. Default template supports tokens:

    • verse (Required): Contains the full Bible reference, including book, chapter, and verse or range of verses.
    • version (Optional): Contains the Bible version. If included but missing in the selected reference, the default version set in the plugin configuration will be used.

  2. Olive Tree template supports tokens:

    • book (Required): Contains the book name of the Bible reference.
    • chapter (Required): Contains the chapter number.
    • verse (Required): Contains the verse number.

Link to Verse detects the template type based on the tokens used. If your template includes book, chapter, and verse, it is identified as an Olive Tree template; otherwise, it defaults to the Default template.

📚 Examples

BibleGateway Support

Settings:

Case 1

Input: John 3:16 Output: [John 3:16](https://www.biblegateway.com/passage/?search=John+3:16&version=NLT)

Case 2

Input: Jn 3:16 Output: [Jn 3:16](https://www.biblegateway.com/passage/?search=John+3:16&version=NLT)

Olive Tree URL Support

Settings:

Since Olive Tree does not support Bible translations, they are ignored.

Case 1

Input: 1 Timothy 3:16 Output: [1 Timothy 3:16](olivetree://bible/1%20Timothy.3.16)

Case 2

Input: SS 4:7 Output: [SS 4:7](olivetree://bible/SS.4.7)

🛡️ License

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

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

🙏 Acknowledgements

📬 Contact

If you have any questions, suggestions, or issues, please visit the GitHub repository and open an issue.

"Your word is a lamp to my feet and a light to my path." - Psalm 119:105