hexo-tag-scripture
v1.0.1
Published
A tag plugin for Hexo to easily generate Scripture references linked to Bible Gateway
Downloads
9
Readme
hexo-tag-scripture
A Hexo tag plugin to easily link Scripture references to Bible Gateway
Installation
npm install --save hexo-tag-scripture
Docs, TL;DR-Style
Scripture Reference Links
{% scripture John 3:16 %}
becomes
<a href="https://www.biblegateway.com/passage/?search=John+3:16&version=ESV" title="Read John 3:16 (ESV) at Bible Gateway">John 3:16</a>
(See below for version aliases.)
Scripture Blockquotes
{% bible John 3:16 %}
The **text**
{% endbible %}
becomes
<blockquote class="bible">
The <strong>text</strong>
<cite>— [the linked reference from the previous example]</cite>
</blockquote>
Documentation
This plugin provides two different styles of tags - reference links and blockquotes. The TL;DR version has examples of each.
Common Options
Both tags support a set of options that can be specified after the passage reference.
version
is the abbreviation for the translation (version) that should be linked.version:esv
is the default.extra
is extra text that will be placed immediately after the reference. If you had quoted the first part of a verse, passingextra:a
would result in an "a" right after the closing anchor tag.show-version
specifies that the version abbreviation should be shown after the linked reference. If present, the italicized version abbreviation, in parentheses, will be generated, and separated from the link by one space.
A complete example, using the scripture
tag...
{% scripture John 3:16 version:csb extra:a show-version %}
becomes
<a href="https://www.biblegateway.com/passage/?search=John+3:16&version=CSB" title="Read John 3:16 (CSB) at Bible Gateway">John 3:16</a>a <em>(CSB)</em>
Reference Link Aliases
The plugin uses the English Standard Version (ESV) as the default translation (version
). However, to simplify links to commonly-used versions, the following tags serve as aliases to their respective version:xxx
options to the scripture
tag.
csb
(Christian Standard Bible)esv
(English Standard Version)hcsb
(Holman Christian Standard Bible)kjv
(King James Version)niv
(New International Version)nkjv
(New King James Version)
Other versions that Bible Gateway supports would be easy; create an issue (or PR). :)
Example
This plugin was originally developed as I migrated the (now inaccurately named) Daniel's Weekly Devotions site, where you can see its results; all actual Scripture references and blockquotes use this plugin to generate them. An overview of how this plugin was developed can be found on the DJS Consulting Tech Blog.