Skip to content

An unofficial Obsidian plugin that turns links into bibliographies in styles like Harvard, MLA, APA, and more

License

Notifications You must be signed in to change notification settings

kadisonm/obsidian-reference-generator

Repository files navigation

Reference Generator

An Obsidian plugin that turns links into bibliographies in styles like Harvard, MLA, APA, and more.


This plugin is not an official Obsidian plugin.

To track the development, please visit the project page.

Generation speed

Please note that in the current version (1.0.0) the plugin's generation time can be quite slow. This is due to relying on a third party API for citation data, which varies in speed for each link. The API also uses an outdated version of the Zotero Translation Server. Please take these into account and be prepared for slower generation speeds with a higher number of links.

On the bright side, there is a fix for this. A different implementation of the translation server is hopefully planned and possible for 1.1.0, so please keep an eye out.

This plugin offers:

  • Generating references for multiple links in one selection
  • Over 2000 styles to choose from
  • A variety of customisation and settings

Installation

Network usage

This plugins requires internet access for the following:

How to use

Default styling

A default citation style can be selected in the plugin settings. This allows you to generate references without having to select a style each time. It is recommended to enable 'Sort by alphabetical order' for styles such as IEEE and MLA.

Generating a reference

Right click on a link to open the context menu and display the generation options. You can either select a style or use your default (depending on your preferences either one of these can be disabled via settings). Alternatively, a command can be used for either.

Obsidian_jk3RtuMY50

Generating multiple references at a time

Select multiple links, right click and follow the same steps for generating a reference. Each link roughly takes 1-3 seconds to generate but they can take longer. There are plans in the future to heavily reduce this time. Text inbetween links is saved, but it will treat all links as a bibliography regardless of what text is inbetween. If you would like two seperately sorted bibliographies, it is best to generate these seperately.

Obsidian_02WQ7bYSf9

Image: Example of selecting multiple links to generate

Why am I receiving 'Error: Could not connect to site'

This is because the requested site could not be reached. This can happen due to network connectivity issues, or the requested page not existing on the site (404 error).

Contributors

Thanks to @FeralFlora and @mariomui for helping steer this project in the right direction. Especially for coming up with the idea to use Citeproc-js and Zotero translators.

Show your support

If you want to support me you can do so here, but please know that this is not expected and this plugin is completely free.

Thank you so much for using my plugin.

About

An unofficial Obsidian plugin that turns links into bibliographies in styles like Harvard, MLA, APA, and more

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages