Description

Use locally stored BibTeX files to integrate citation into Joplin

Additional Information

Links:
Maintainers: laurent22 abdallah500 tessus calebjohn
Version:0.5.0
Minimum app version:1.7
Downloads: This version:2783
Last updated:2021-08-02T11:05:17Z

Joplin BibTeX Plugin

npm version npm

Many users use Joplin for research purposes, so it is natural for them to do citation all the time. Therefore, adding a feature that supports citing references in BibTeX format will be of great benefit to Joplin. And here it is :)

BibTeX Plugin Demo

Features

  • Import a source of research references (a .bib file).
  • Allow the user to choose from a list of previously imported references.
  • Insert references into the note content.
  • Render a full list of references at the bottom of the note viewer (in APA format)

Installation

  • Open Joplin
  • Go to Tools > Options > Plugins
  • Search for bibtex
  • Click Install plugin
  • Restart Joplin to enable the plugin

How to use

  • Prepare a BibTeX file (if you are using Zotero, you can export your library as a .bib file).
  • Go to Tools > Options > BibTeX Plugin Section.
  • Specify the path of your .bib file and click Apply.
  • To Import a reference into your note content, simply click on the plugin icon in the toolbar and choose which references to include, then click OK.
  • You will see that the references you selected were inserted in the current position in the note body. Furthermore, any reference you include will automatically appear at the bottom of the note viewer.

Building the plugin

The plugin is built using Webpack, which creates the compiled code in /dist. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run npm run dist. The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.

Testing

To test the plugin, simply run npm test. The testing library used is Jest.