Getting Started
Obsidian Plugin

Obsidian Plugin Setup

Install Plugin

Latest Version:1.1.0-beta.14
Required Obsidian Version:1.4.4

Beta versions are not production-ready, make sure to make proper backup before preceeding.

You can use the Beta Reviewers Auto-update Tester (BRAT) plugin to install a pre-release version of the plugin.

Install BRAT

Download BRAT (opens in a new tab) and enable it

Add a beta plugin for testing

  1. Open the command palette and run the command BRAT: Add a beta plugin for testing

If you want the plugin version to be frozen, use the command BRAT: Add a beta plugin with frozen version based on a release tag.

  1. Copy PKM-er/obsidian-zotlit into the modal that opens up

  2. Click on Add Plugin -- wait a few seconds and BRAT will tell you what is going on

Enable the beta plugin

  1. After BRAT confirms the installation, Open Settings > Community plugin
  2. Refresh the list of plugins
  3. Find the beta plugin you just installed and Enable it.

Follow the setup instructions

Basic Setup

Unlike other citation plugins, this plugin read Zotero's database directly to deliver the best performance with full access to Zotero's data.

To use this plugin, some additional setup is required:

Download Binary

The plugin requires a binary (better-sqlite3) to connect to Zotero's database. Normally, a modal will pop up the first time you open the plugin, and ask you to download the binary. Follow the instructions in the modal to download the binary.

Binary Install Guide

This modal will also show up if the binary is broken or outdated, so that you can reset or update the binary.

Locate Zotero's Database

The plugin needs to know where Zotero's database is located. If you haven't moved your Zotero's database to a different location, the plugin should be able to locate it automatically. In the Settings > Connect, you should see a path to your Zotero's database marked green. (If you've installed Better BibTex in Zotero, the path will also be green.)

Zotero Database Location Config

If you have moved your Zotero's database, you need to tell the plugin where it is. You can find the path to your Zotero's data directory by opening Zotero, and go to Preference > Advanced > Data Directory Location.

Zotero Database Location