Installation

NOTE

The installation guide for the WordPress plugin and browser extension can be found in the Plugin and Extensions section.

BibleUp can be installed with NPM if you have node installed on your system and if you use a build tool. It can also be served from a CDN.

NPM

npm install @bibleup/bibleup

// ES6 Modules
import BibleUp from "@bibleup/bibleup"

// CSS Theme
import "@bibleup/bibleup/css"

CDN

To serve BibleUp through a CDN, place the following code before the closing </body> in the HTML file:

<!-- jsdelivr -->
<script src="https://cdn.jsdelivr.net/npm/@bibleup/bibleup@1"></script>

BibleUp Core

BibleUp comes with the default CSS theme (for the popovers) pre-bundled into the build, providing a single minified code.
However, you can decide to include BibleUp Core API and CSS separately.

NPM:

After npm install:

import BibleUp from '@bibleup/bibleup'

CDN:

To use the CDN, you can either import the core ESM build:

import BibleUp from 'https://cdn.jsdelivr.net/npm/@bibleup/bibleup@1/+esm'

or use <script> in your HTML:

<script src="https://cdn.jsdelivr.net/npm/@bibleup/bibleup@1/dist/umd/bibleup-core.min.js "></script>

CSS

Lastly, include the CSS:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@bibleup/bibleup@1/dist/css/bibleup.css">

NOTE

• Using the CDN allows you to get code fixes, new features and improvements automatically when BibleUp is updated.

• When using a CDN, We recommend that you pin BibleUp to a specific version or the latest major version - as done in the examples above (@bibleup/bibleup@1). This is to prevent breaking changes when a major version is released.