simsapa / simsapa-extensions-and-plugins

Simsapa Extensions and Plugins

Simsapa Extensions and Plugins

Companion tools for the Simsapa Dhamma Reader sutta reader and Pāli dictionary application.

• Firefox
• Chrome:
  • Install from the .zip file for the time being, see the steps
• Obsidian
  • Install from Obsidian: Settings > Community Plugins > Browse
  • Repo: simsapa-obsidian
• Joplin
  • Install from Joplin: Tools > Options > Plugins
  • Repo: simsapa-joplin
• Emacs package
• Neovim plugin
• Google Docs addon

Install the Chrome plugin

The Chrome plugin is not yet published in the web store.

• Download simsapa-chrome.zip
• Extract to a folder
• Open Menu > Extensions > Manage Extensions (chrome://extensions/)
• Enable Developer mode in the top-right corner
• Click Load unpacked, open the extracted extension folder
• The extension is now installed
• (📙 NOTE: Deleting the folder also removes the extension)

Development

Clone and build

The extension sidebar is built in this repository (src/sidebar.ts), and bundled into the extensions as sub-module repos.

Clone the repository with the submodules:

git clone --recurse-submodules https://github.com/simsapa/simsapa-extensions-and-plugins.git
cd simsapa-extensions-and-plugins

Later you can update the submodules with:

git submodule update --recursive --remote

Setup

Setup the dependencies. Poetry is required for Python packages.

npm install

poetry install

npm install -g web-ext

The Obsidian and Joplin plugins have further dependencies:

cd src-obsidian
# or
cd src-joplin
npm install

For the Google Docs Addon:

npm install -g @google/clasp

Start the Python venv and run the relevant make target to build the extension:

poetry shell

make dist-firefox
make dist-chrome
make dist-obsidian
make dist-joplin
make dist-gdocs

(The Emacs and Neovim package doesn't need a build step.)

Install from the local folder

The packaged (.zip) extension files will be in the dist/ folder.

The un-packaged extension will be in the folders:

dist-firefox/
dist-chrome/
dist-obsidian/
dist-joplin/
dist-gdocs/