Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 5.02 KB

README.md

File metadata and controls

73 lines (54 loc) · 5.02 KB
Raw

BibleGateway-to-Obsidian

This script is forked from selfire1's BibleGateway-to-Obsidian, which adapts jgclark's wonderful BibleGateway-to-Markdown script to export for use in Obsidian. It accompanies a Bible Study in Obsidian Kit that gets you hands-on with using Scripture in your personal notes.

What the script does is fetch the text from Bible Gateway and save it as formatted markdown file. Each chapter is saved as one file and navigation between files as well as a book-file is automatically created. All of the chapter files of a book are saved in it's numbered folder.

This script is intended to be as simple as possible to use, even if you have no idea about Scripting. If you have any questions, please reach out to me either on github or Discord (selfire#3095).

Important Disclaimers

  • This is not affiliated to, or approved by, BibleGateway.com. In my understanding it fits into the conditions of usage but I make no guarantee regarding the usage of the script, it is at your own disgression.
  • By default, the version is set to the ESV. You can change the version, as long as you honour the copyright standards of different translations of the Bible (See: BibleGateways overview).
    • Change ESV to XXX in config.sh
  • I have little experience in scripting–through this project I taught myself bash and regex basics. If you run into issues or have a way to simplify this script, please raise an issue or reach out on Discord (selfire#3095).

Installation

Here are the tools we are going to use:

  • Our command line (Terminal)
  • A text editor (like Atom).

Setting ruby up

Updating

In order to run the scripts, we will need to install ruby. Ruby comes pre-installed on MacOS but if you run into issues, update to the latest version.

Downloading BibleGateway-to-Markdown.rb

Follow the instructions to download and set up jgclark's BibleGateway-to-Markdown.

Note: If you are cloning this repository with git please use the --recurse-submodules with git to download the submodules *git clone --recurse-submodules https://github.com/joebuhlig/BibleGateway-to-Obsidian.git

Usage

1. Navigate to the directory in which both scripts are located.

Open terminal. Use the following command to navigate to the folder in which both scripts are located:

  • pwd Show your current directory
  • ls List all contents in the current directory
  • cd Enter 'down' in a subdirectory (E.g. cd Desktop)
  • cd .. Brings you 'up' one directory

2. Run the script

Once you are in the directory, run bash bg2obs.sh. This will run the bash script.

NOTE: In this directory, a folder called ESV with subfolders like 01 - Genesis, 02 - Exodus and so on will be created.

Within the bg2obs.sh file you have the options to include headers and set the words of Jesus to bold. By default, both options are set to false.

3. Format the text in a text editor

We will need to format the output to work well in Obsidian.

  1. Open Atom (or the like).
  2. Open the ESV folder with File > Add Project Folder… (or Shift + Command + O
  3. Open project-wide search with Shift + Command + F

Next up we are going to run two Regex-searches to find and replace in our whole project.

  1. Enable Regex. Click the .* Icon.
  2. Run the first search. This clears unnecessary headers:
  • Find: #.*(#####\D[1]\D)
  • Replace: #$1
  • file: *.md
  1. Run the second search. This formats verses into h6:
  • Find: ######\s([0-9]\s|[0-9][0-9]\s|[0-9][0-9][0-9]\s)
  • Replace: \n\nv$1
  • file: *.md (Some crossreferences are sometimes still included, run \<crossref intro.*crossref\> to delete.)

4. Split each virse to it's own file.

  1. Run bash versesplit.sh to split the chapters in to seprate verse files.
  2. Run bash masterfiles.sh to create the link file for each book. This only works if you split the files, do not run on it's own.
  3. (Optional) Run bash rename-folders.sh to add book numbers to the folder for sorting.

There you go! Now, just move the "ESV" folder into your Obsidian vault. You can use the provided The Bible.md file as an overview file. (Not setup with folder numbers)

Translations

This script downloads the ESV by default. If you wish to use a different translation, open the confg.sh file in a text editor and follow the annotations in there (It is just changing one line). Make sure to honour copyright guidelines.