• Stars
    star
    1,107
  • Rank 41,944 (Top 0.9 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 4 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Obsidian plugin which integrates your academic reference manager with the Obsidian editor. Search your references from within Obsidian and automatically create and reference literature notes for papers and books.

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 four 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 literature note content in the current pane (no hotkey by default): insert content describing a particular reference into the current pane. (This can be useful for updating literature notes you already have but which are missing reference information.)
  4. 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.)

Templates

You can set up your own template for both the title and content of literature notes. The following variables can be used:

* {{citekey}}
* {{abstract}}
* {{authorString}}
* {{containerTitle}}
* {{DOI}}
* {{eprint}}
* {{eprinttype}}
* {{eventPlace}}
* {{page}}
* {{publisher}}
* {{publisherPlace}}
* {{title}}
* {{titleShort}}
* {{URL}}
* {{year}}
* {{zoteroSelectURI}}

For example, your literature note title template can simply be @{{citekey}} and the content template can look like:

---
title: {{title}}
authors: {{authorString}}
year: {{year}}
---
{{abstract}}

License

MIT License.

Contributors

More Repositories

1

glove.py

Python implementation of GloVe word embedding algorithm (Pennington et al., 2014) for educational purposes
Python
222
star
2

ipython-notebooks

Informal IPython experiments and tutorials. TensorFlow, machine learning/deep learning/RL, NLP applications.
Jupyter Notebook
147
star
3

nn-decoding

Brain decoding/encoding with neural network language models
Jupyter Notebook
54
star
4

gitchart

Generate cool stats about Git repositories
Ruby
23
star
5

rlcomp

Python
18
star
6

lwt

Learning with Texts (LWT) is a tool for Language Learning. Please use the official download @ lwt.sourceforge.net. ***** THE VERSIONS HERE ARE NOT FOR DOWNLOAD ***** IF YOU DO - USE IT AT YOUR OWN RISK! *****
PHP
13
star
7

pyccg

A Python library for distantly supervised CCG parsing/learning, based off of NLTK's CCG implementation
Python
11
star
8

corenlp-summarizer

Spanish text summarization demo using CoreNLP
Java
10
star
9

webnav

A situated language acquisition simulation in which a "child" learns to acquire a language from a "parent" in order to solve the Wikipedia Game.
Python
9
star
10

hans.github.com

TeX
8
star
11

twitkit

TwitKit is a Twitter sidebar for Firefox.
JavaScript
7
star
12

ace-live

Collaborative code editing powered by Node.js, Now / socket.io, and ACE Editor
CoffeeScript
6
star
13

dotfiles

hans's dotfiles
Perl
6
star
14

forvo-downloader

Quick CLI tool to download Forvo pronunciations
Python
4
star
15

langdetect

Spoken language detection (Stanford CS 229 class project)
Python
4
star
16

git-extras

Teeny little tools to make developing with Git even easier.
3
star
17

clevr-oneshot

Python
3
star
18

ical2csv

Enumerates events described in an iCal ICS file and saves their data to a CSV file
Python
3
star
19

anki-glosbe

Glosbe dictionary lookup addon for Anki
Python
2
star
20

grabnix

grabUp for Linux users!
Ruby
2
star
21

tidbits

Random little tools to make life easier
2
star
22

jido-rb

Painless, dynamic (XML-powered) verb conjugation
Ruby
2
star
23

pastebot

pastebin written in Node.js
CoffeeScript
2
star
24

universal-remote

Send keystrokes to any application from your Apple Remote (written in nooby RubyCocoa)
Objective-C
2
star
25

praglang

Pragmatic language acquisition
Python
2
star
26

typr

A social typing-competition app. Rails + Devise + Omniauth + Haml + CoffeeScript + Redis
JavaScript
2
star
27

snippet

Command-line interface for managing code snippets
Ruby
2
star
28

specimen

A library of sample code, showing how to do things in tons of languages.
Ruby
2
star
29

wikispeedia

A tool to convert the Wikispeedia dataset into a format convenient for the web-navigation learning task.
Python
2
star
30

jido-data

XML data for an upcoming verb conjugator project
2
star
31

color-theme-n0tch2k

n0tch2k color theme for Emacs
Emacs Lisp
2
star
32

thinstack-rl

Python
2
star
33

anki-osx-audacity

Anki addon to open sounds within a card with Audacity on OSX
Python
1
star
34

puddle-world

Jupyter Notebook
1
star
35

evo-ref

Evolution of referential utterances
Python
1
star
36

jido-site

Web frontend for Jido
JavaScript
1
star
37

hsp2

Jupyter Notebook
1
star
38

gaeunit-mode

gaeunit-cli hooks for emacs
Emacs Lisp
1
star
39

isight-streamer

Stream iSight video frames to a RabbitMQ queue
Python
1
star
40

dvcs-neural-network

Java
1
star
41

deepBLE

Python
1
star
42

polarclock

A Java implementation of a polar clock.
Java
1
star
43

kedai

In-memory key-value store written in Clojure
Clojure
1
star
44

gaeunit-cli

Run GAEUnit tests from the command line
Python
1
star
45

music-evolution

Generate chords through artificial evolution
Clojure
1
star
46

spatial-references

JavaScript
1
star
47

infinite-pcfg

Python
1
star