Build and deploy beautiful documentation sites that grow with you

Build and deploy beautiful documentation sites that grow with you

OrchidBible

Load the full text of Bible verses quickly and easily.

official markup

About

OrchidBible makes it easy to embed Bible verses in your site content. Just pass in the reference to a verse and Orchid will look up the verse text and add it to your site automatically.

Demo

~ John 3:16

~ Galatians 2:19-21

Usage

Basic Usage

Bible verses can be added simply by passing their reference to the bible function. The verse text will be downloaded and displayed on the page, along with the verse reference. The Bible version must be the id of one of the available versions on Bibles.org.

As a filter

{{ "John 3:16"|bible("eng-KJV") }}

As a function

{{ bible("Galatians 2 19-21", "eng-NASB") }}

Configuration

You will need to sign up for an API key for the Bibles.org API to download verse text. Once you create and account and get an API key, add it to Orchid using the --absApiKey CLI flag, or set it as an environment variable at absApiKey.

orchid {
    ...
    args += ["--absApiKey", "${project.property('ABS_API_KEY')}"]
}

You can also set the default Bible version with the --absDefaultVersion flag. This will be the version used if you do not pass one to the bible() function.

orchid {
    ...
    args += ["--absDefaultVersion", "eng-NASB"]
}
dependencies {
    orchidRuntime("io.github.javaeden.orchid:OrchidBible:0.18.0")
}
<dependency>
    <groupId>io.github.javaeden.orchid</groupId>
    <artifactId>OrchidBible</artifactId>
    <version>0.18.0</version>
    <type>pom</type>
</dependency>
@file:DependsOn("io.github.javaeden.orchid:OrchidBible:0.18.0")