Researcher Library

by proflead
5
4
3
2
1
Score: 50/100
New Plugin

Description

Reviews

No reviews yet.

Stats

1
stars
downloads
0
forks
0
days
0
days
0
days
1
total PRs
0
open PRs
0
closed PRs
1
merged PRs
0
total issues
0
open issues
0
closed issues
5
commits

Latest Version

8 hours ago

Changelog

Researcher Library 1.1.0

This release prepares Researcher Library for the Obsidian Community Plugins directory.

Highlights

  • safer, transactional PDF imports with collision handling and rollback
  • stable PDF and note associations with rename tracking
  • editable and correctly separated publication-year metadata
  • automatic library refresh and clearer PDF, note, search, sort, and removal workflows
  • responsive styling and backward compatibility with existing paper records
  • modernized build, lint, release, documentation, and privacy disclosures

Requires Obsidian 1.7.2 or newer.

README file from

Github

Researcher Library

Researcher Library is an Obsidian plugin for importing, organizing, and annotating research papers without moving the workflow outside your vault.

Features

  • Import one or more PDF files from the ribbon, command palette, or library view.
  • Read embedded PDF metadata such as title and author.
  • Track publication year, category, and reading status.
  • Search and sort the library by common paper fields.
  • Open a paper's PDF directly or create a linked note for it.
  • Keep paper records connected when their managed PDF or note is renamed.
  • Remove a paper record, its PDF, and its note through Obsidian's trash flow.

PDF creation dates are stored separately from publication years. A PDF's creation date usually describes when the file was produced, not when the paper was published.

Usage

  1. Open Researcher library from the book icon in the ribbon.
  2. Select Import, then choose one or more PDFs.
  3. Select a paper title or its PDF button to open the document.
  4. Use the note button to create or open a linked research note.
  5. Use the pencil button to edit metadata or remove the paper.

If an imported filename is already in use, the plugin creates a numbered copy instead of overwriting existing vault data.

Vault layout

The plugin keeps its managed files under researcher-library/:

researcher-library/
├── notes/       # Research notes
└── papers/
    ├── md/      # Paper metadata records
    └── *.pdf    # Imported PDFs

Existing records created by earlier versions remain supported through filename-based fallback links.

Development

Requirements: a current Node.js LTS release and npm.

npm install
npm run dev

The development command watches the TypeScript sources and writes main.js to the repository root, matching Obsidian's plugin directory layout.

Before submitting a change, run:

npm run lint
npm run build

Releasing

  1. Run npm version patch, npm version minor, or npm version major as appropriate.
  2. Run npm run build.
  3. Create a GitHub release whose tag matches manifest.json.
  4. Attach main.js, manifest.json, and styles.css to the release.

Contributing

Issues and pull requests are welcome.

Privacy

Researcher Library does not require an account, connect to external services, collect telemetry, or send vault data over the network. Imported PDFs, metadata records, and notes remain inside the user's vault.

License

Researcher Library is available under the MIT License.

Support