Options
All
  • Public
  • Public/Protected
  • All
Menu

Project obsidian-citation-plugin

obsidian-citation-plugin

This plugin for Obsidian integrates your academic reference manager with the Obsidian editing experience.

The plugin supports reading bibliographies in BibTeX / BibLaTeX .bib format and CSL-JSON format.

Setup

You can install this plugin via the Obsidian "Third-party plugin interface." It requires Obsidian 0.9.20 or higher.

Once the plugin is installed, you must provide it with a bibliography file:

  • If you use Zotero with Better BibTeX:
    • Select a collection in Zotero's left sidebar that you want to export.
    • Click File -> Export library .... Select Better BibLaTeX or Better CSL JSON as the format. (We recommend using the BibLaTeX export unless you experience performance issues. The BibLaTeX format includes more information that you can reference from Obsidian, such as associated PDF attachments, but loads more slowly than the JSON export.)
    • You can optionally choose "Keep updated" to automatically re-export the collection -- this is recommended!
  • If you use other reference managers, check their documentation for BibLaTeX or CSL-JSON export support. We plan to officially support other managers in the future.

Now open the Obsidian preferences and view the "Citations" tab. Paste the path to the exported file (.bib or .json, depending on the format you chose) in the text field labeled "Citation export path." After closing the settings dialog, you should now be able to search your references from within Obsidian!

Usage

The plugin offers three simple features at the moment:

  1. Open literature note (Ctrl+Shift+O): automatically create or open a literature note for a particular reference. The title, folder, and initial content of the note can be configured in the plugin settings.
  2. Insert literature note reference (Ctrl+Shift+E): insert a link to the literature note corresponding to a particular reference.
  3. Insert Markdown citation (no hotkey by default): insert a Pandoc-style citation for a particular reference. (The exact format of the citation can be configured in the plugin settings.)

License

MIT License.

Contributors

Generated using TypeDoc