Literature Flow

approved

by michellegdyason

Open-access literature discovery and citation mapping - This plugin has not been manually reviewed by Obsidian staff.

1 stars263 downloadsUpdated 1mo agoGPL-3.0

GPL-3.0 license Downloads GitHub version Build Status Release Date

[!IMPORTANT] Literature Flow is a modified version of anoopkcn/obsidian-reference-map, originally created by Anoop K. Chandran. It was renamed and modified on June 6, 2026 to add OpenAlex open access search. See NOTICE.md for attribution and modification details.

LF-Header-logo

Literature Flow

Literature Flow is an Obsidian plugin for open-access literature discovery, reference management, and citation mapping. OpenAlex is the default source, and open-access-only filtering is applied to search, cited and citing works, and the literature graph.

Project documentation is maintained in this README.

Contents

  1. Requirements
  2. Installation
  3. Usage
  4. Configuration

Requirements

  • Obsidian with community plugins enabled

Installation

From Community Plugins

After the plugin is accepted into the Obsidian community directory, install it through Settings → Community Plugins → Browse → Literature Flow.

Manual Installation

  1. Download the latest release from here and unzip it.
  2. Copy the obsidian-literature-flow folder to your vault's .obsidian/plugins folder.
  3. Reload Obsidian.
  4. Enable the plugin in the community plugins section.

You can also use BRAT with MichelleGDyason/obsidian-literature-flow.

Usage

This README contains the current installation, usage, and configuration guide.

Main features:

  • Literature Flow Sidebar - View details of your references in the current document.
  • Literature Flow Search - Search for references online to create or insert details.
  • Literature Flow Graph - A graph view showing all the references and their citing/cited references and connection between them.

Literature Flow Sidebar

Literature Flow Sidebar View contains Index cards and citing/cited cards.

Index Cards are detected from the markdown document using ID's(see the Static Reference List section below)

Citing/cited cards show a searchable and sortable list of cited and citing papers of a reference contained in the index card.

Each Index card or citing/cited card in the view will show the following information:

ButtonSectionDescriptionOn Click
textTitleTitle of the paperOpen the best available open-access location, or a configured institutional-library link
AbstractAbstract of the paper (Default=OFF)-
textAuthorsAuthors of the paperOpen the author's details in the selected metadata source
YearYear of publication-
textcitekeyPandoc citekey (Default=OFF)Open reference in the Zotero Library
(1)Metadata copyUser defined format of metadata. Default=bibtex of the paperCopy the <bibtex> to the clipboard (If Batch copy is enabled it will copy <bibtex> for all the cited paper)
(2)Metadata copyUser defined format of metadata Default=Formatted metadata detailsCopy the <metadata> to the clipboard (If Batch copy is enabled it will copy <metadata> for all the cited paper)
(3)Metadata copyUser defined format of metadata. Default=Reference title as wikilink (Default=OFF)Copy the <wikilink> to the clipboard (If Batch copy is enabled it will copy <wikilink> for all the cited paper)
(4)PDFOpen Access PDF of the paperOpen the Open Access PDF of the paper if it is present for a reference
(5)Reference countNumber of referencesOpen a searchable list of all cited papers (References)
(6)Citation countNumber of citationsOpen a searchable list of all citing papers (Citations)
Influential citation countNumber of influential citations (Default=OFF)-

You can customize the content of metadata buttons(1,2,3) according to your workflow, possible variables for the metadata template for the buttons copy/create contents are listed in the settings tab

Batch operations are exclusive to Index Cards

Static Reference List

Reference IDs (DOI, arxiv, corpusID, URL, citeKey, etc,.) that are found in the current document are listed in the Literature Flow view. Valid IDs can be added anywhere in the document and they will be detected.

The following types of IDs are supported:

ID SyntaxDescriptionExample
DOI:<doi>A Digital Object Identifier.DOI:10.18653/v1/N18-3011 or 10.18653/v1/N18-3011v1
@<citekey>Zotero citekey(Default=OFF)*@smith2019attention
ARXIV:<id>arXiv.orgARXIV:2106.15928
MAG:<id>Microsoft Academic GraphMAG:112218234
PMID:<id>PubMed/MedlinePMID:19872477
PMCID:<id>PubMed CentralPMCID:2323736
URL:<url>URL from sitesURL:https://arxiv.org/abs/2003.05991
CorpusId:<id>Semantic Scholar numerical IDCorpusId:215416146

*To enable CiteKey support(for Zotero or for other reference managers), Activate Pull from zotero option and select a library OR one has to provide a Bibtex CSL JSON(Better BibTex Zotero Plugin feature, auto updates with changes in the library) or CSL JSON(Generic CSL library from any reference manager) file or BibTeX file with .bib extension. Once enabled in the settings, the plugin can recognize the citekey entries.

[!IMPORTANT]
Make sure in Zotero library DOI field(or the URL field) contains a valid ID. Otherwise metadata from the local Library is shown in the sidebar(with no metadata from online sources)

For Static Reference List, selecting the ID in the markdown file will highlight the corresponding card in the Literature Flow Sidebar view.

Dynamic Reference List

The Literature Flow Sidebar view can also be configured to show a list of references that correspond to the filename of the note or frontmatter keywords. Check out the settings tab to configure the plugin behaviour

Example: For a file named Attention is all you need.md cards will be displayed for references that match Attention+all+need.

For frontmatter keywords, you can configure a keyword to be used for reference search. By default, the keyword is keywords.

Example: For a frontmatter given as follows:

---
keywords: autoencoders, machine learning
---

Cards will be displayed for references that match autoencoders+machine+learning.

Dynamic sidebar cards show match-source tags such as Filename terms: Attention or Frontmatter terms: keywords: autoencoders, learning. These tags list the query terms found in that result's returned metadata. Hover a tag to see the raw query sent to the literature source, so irrelevant results can be traced back to the filename or frontmatter search that produced them.

Use Minimum matched terms in settings to filter weak dynamic recommendations. The default is 3, which means a result from a filename or frontmatter search is shown only when at least three query terms appear in that result's returned metadata. If the query has fewer than three terms, all available query terms must match. Set the value to 0 to disable this filter.

Note that since new references are added to the database regularly the dynamic list might not stay the same each time you open the file. Especially for generic keywords like machine learning, deep learning, history etc.

This feature can be used for keeping up to date with the latest research in a specific field as well

Literature Flow Search

Search for references and citations online to create or insert details. You can locate the commands by opening the Obsidian command palette (Ctrl/Cmd + P) and typing Literature Flow. By default no hotkeys are se for the commands, but you can easily add them in the Hotkeys tab.

If you select a text in the current document and then issue the command the selected text will be used as the search query.

CommandDescriptionHotkey
Literature Flow: Search and InsertSearch for references online to insert details in the current document.-
Literature Flow: Search and CreateSearch for references online to create a new markdown file using the details-

You can configure the insert template in settings. New notes can use either the inline create template or separate Markdown template files from your vault.

Vault templates for new notes

Enable Use vault templates for new notes under Literature Flow settings → Discovery and access, then select:

  • A Journal article template for articles and other non-book works.
  • A Book template for books, monographs, edited books, and book chapters.

Literature Flow reads the selected template without modifying the template file. It replaces supported {{variables}} and fills matching YAML fields when their current value is blank, null, or ends in ?. Existing completed YAML values, lists, custom fields, and the note body are preserved.

Supported variables include:

{{title}} {{author}} {{authors}} {{year}} {{journal}}
{{volume}} {{issue}} {{pages}} {{abstract}} {{doi}}
{{url}} {{pdfurl}} {{publisher}} {{publicationType}}
{{publication_type}} {{type}} {{citekey}} {{source}}
{{bibtex}} {{csl}}

Common YAML keys filled automatically include title, author, authors, year, journal, volume, issue, pages, doi, publisher, publication_type, citekey, source_url, pdf_url, abstract, and type. The generated type value is reading_note; publication_type is Journal article or Book.

Discovery and access

The literature source applies consistently to Search Online, dynamic note searches, sidebar reference and citation lists, and the literature graph:

  • OpenAlex is the default and supports open-access search and citation traversal.
  • Semantic Scholar can be selected for its paper index.
  • OpenAlex + Semantic Scholar queries both sources, removes duplicates, and prefers the OpenAlex record when both describe the same DOI.

Open access only is enabled by default. A work flows into Literature Flow only when the selected source supplies a usable open-access location. Clicking its title opens that location directly rather than sending you through a general index page.

Reference and citation counts remain visible at the bottom of expandable sidebar cards. Hovering a count identifies it as References cited by this work or Works citing this reference. Opening a count loads that list on demand, and entries in those lists can be expanded again.

Affiliated researchers can disable Open access only to include restricted works. The optional Institutional access link template can then route those title links through a university or library login. Use {{url}} for the encoded DOI or publisher destination and {{doi}} for the encoded DOI value. For example:

https://ezproxy.example.edu/login?url={{url}}

OpenAlex now uses a credit-based API and provides the normal free daily allowance with a free API key. Create one at openalex.org/settings/api, then enter it under Literature Flow settings → Discovery and access. Unauthenticated usage is intentionally very limited.

Literature Flow Graph

Open command palette and run Literature Flow: Open Literature Graph to open the graph view. Reveal connection between the entries. Size of each node indicating the citations it received

  • Click on a node to show the details on top of the graph
  • Hover to show the title.
  • Pan to zoom in/out (you can also use node right click to zoom in/out)
  • Drag to move the graph
  • Drag a node to move it around and fix it in place

[!IMPORTANT]
Literature Flow graph will show details of published papers. It will not show details for entries corresponding to videos, webpages, twitter, etc,. in your local library but it is shown in the sidebar view.

Configuration

If you want to configure the style of the view you can use the Obsidian-style-settings plugin.

The settings tab contains options to configure the behaviour of the plugin.

License

This project is distributed under the GNU General Public License v3.0. It retains the upstream license and records the rename and OpenAlex changes in NOTICE.md and the changelog.

Please feel free to open an issue if you find any bugs or have any suggestions at GitHub Issues Page

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.