Changes documented in the changelog
I will get this plugin registered in the community plugins when there is some testing and stability. Until then...
The ESV.org API requires a token to use. A public token is provided by default, but there are caps imposed by ESV.org. For details on thresholds, see https://api.esv.org/#conditions. Please be considerate and rate-limit yourselves to not exceed the threshold. If caps are exceeded excessively, I will implement limits and/or disable the public token.
If you plan on using this plugin to pull an excessive amount of passages, I would appreciate if you would generate your own API token to avoid exceeding the threshold and locking out others using the public token. You can get a token by creating an account and requesting a token (https://api.esv.org/account/create-application).
- Download the
obsidian-bible-reference-plugin-0.0.1.zip
archive from the latest tag here: https://github.com/scottTomaszewski/obsidian-bible-references-plugin/releases - Extract the archive to your
<vault_path>/.obsidian/plugins/
folder - Make sure you have community plugins enabled (Settings > Community Plugins > Safe Mode OFF)
- Enable the Bible Reference Plugin (Settings > Community Plugins > toggle the plugin)
- Clone your repo to a local development folder. For convenience, you can place this folder in
your
<vault_path>/.obsidian/plugins/obsidian-bible-reference-plugin
folder. - Install NodeJS, then run
npm i
in the command line under your repo folder. - Run
npm run dev
to compile your plugin frommain.ts
tomain.js
. - Make changes to
main.ts
(or create new.ts
files). Those changes should be automatically compiled intomain.js
. - Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run
npm update
in the command line under your repo folder.
- Copy over
main.js
,styles.css
,manifest.json
to your vault<vault_path>/.obsidian/plugins/obsidian-bible-reference-plugin/
.