michellegdyason51 downloadsOpen-access literature discovery and citation mapping
[!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.
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.
After the plugin is accepted into the Obsidian community directory, install it through Settings → Community Plugins → Browse → Literature Flow.
obsidian-literature-flow folder to your vault's .obsidian/plugins folder.You can also use BRAT with MichelleGDyason/obsidian-literature-flow.
This README contains the current installation, usage, and configuration guide.
Main features:
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:
| Button | Section | Description | On Click |
|---|---|---|---|
| text | Title | Title of the paper | Open the best available open-access location, or a configured institutional-library link |
| Abstract | Abstract of the paper (Default=OFF) | - | |
| text | Authors | Authors of the paper | Open the author's details in the selected metadata source |
| Year | Year of publication | - | |
| text | citekey | Pandoc citekey (Default=OFF) | Open reference in the Zotero Library |
| (1) | Metadata copy | User defined format of metadata. Default=bibtex of the paper |
Copy the <bibtex> to the clipboard (If Batch copy is enabled it will copy <bibtex> for all the cited paper) |
| (2) | Metadata copy | User defined format of metadata Default=Formatted metadata details |
Copy the <metadata> to the clipboard (If Batch copy is enabled it will copy <metadata> for all the cited paper) |
| (3) | Metadata copy | User 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) | Open Access PDF of the paper | Open the Open Access PDF of the paper if it is present for a reference | |
| (5) | Reference count | Number of references | Open a searchable list of all cited papers (References) |
| (6) | Citation count | Number of citations | Open a searchable list of all citing papers (Citations) |
| Influential citation count | Number 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
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 Syntax | Description | Example |
|---|---|---|
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.org | ARXIV:2106.15928 |
MAG:<id> |
Microsoft Academic Graph | MAG:112218234 |
PMID:<id> |
PubMed/Medline | PMID:19872477 |
PMCID:<id> |
PubMed Central | PMCID:2323736 |
URL:<url> |
URL from sites | URL:https://arxiv.org/abs/2003.05991 |
CorpusId:<id> |
Semantic Scholar numerical ID | CorpusId: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.
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.
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
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.
| Command | Description | Hotkey |
|---|---|---|
| Literature Flow: Search and Insert | Search for references online to insert details in the current document. | - |
| Literature Flow: Search and Create | Search 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.
Enable Use vault templates for new notes under Literature Flow settings → Discovery and access, then select:
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.
The literature source applies consistently to Search Online, dynamic note searches, sidebar reference and citation lists, and the literature graph:
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.
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
[!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.
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.
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