PDF Commenter

pending

by kirangathani

A PDF viewer with an annotation system backed by markdown notes. Select text, create comments with backlinks, and keep everything inside your vault.

3 starsUpdated 4d agoMITDiscovered via Obsidian Unofficial Plugins
View on GitHub

PDF Commenter

An Obsidian plugin for reading and annotating PDFs. Select text, leave comments, and link them to other notes in your vault with backlinks.

Comments are stored as individual markdown notes with frontmatter, not embedded in the PDF. Everything stays in your vault as plain files.

Desktop only.

Features

  • PDF viewer with zoom controls and pinch-to-zoom
  • Select text and create comments anchored to that position
  • Comments pane sits alongside the PDF with scroll sync
  • Each comment is a markdown note — edit it, link to it, find it in search
  • backlinks autocomplete in the comment editor
  • Highlighted text regions rendered on the PDF pages
  • Right-click context menu: copy text, create comment, copy to active note

How it works

When you annotate a PDF, the plugin creates:

  • A sidecar file (<pdf>.mg-comments.json) storing annotation positions and metadata
  • A folder of markdown notes (one per comment) with frontmatter linking back to the PDF

Install

Via BRAT (recommended)

  1. Install the BRAT plugin from Obsidian's community plugin browser (Settings > Community plugins > Browse, search "BRAT").
  2. Open BRAT settings (Settings > BRAT).
  3. Click Add Beta plugin.
  4. Paste the repo URL: kirangathani/pdf-commenter
  5. Click Add Plugin. BRAT will download the latest release and keep it updated.
  6. Enable PDF Commenter in Settings > Community plugins.

Manual install

Download main.js, pdf.worker.js, styles.css, and manifest.json from the latest release and place them in your vault at .obsidian/plugins/pdf-commenter/.

Keyboard shortcuts

General

ShortcutAction
Ctrl+Alt+MCreate comment from selected text
Alt+BackspaceDelete selected comment
Ctrl+Z / Cmd+ZUndo last comment deletion
Alt+DCycle to next comment
Alt+Shift+DCycle to previous comment
Ctrl+F / Cmd+FOpen search bar
EscapeClose search bar / context menu
Ctrl+Scroll / Cmd+ScrollPinch-to-zoom

Comment editor

ShortcutAction
Ctrl+Enter / Cmd+EnterSave comment
[[Open wikilink autocomplete
Arrow Up / Arrow DownNavigate autocomplete suggestions
EnterAccept selected suggestion
EscapeDismiss autocomplete

Search bar

ShortcutAction
EnterNext search result
Shift+EnterPrevious search result
EscapeClose search bar

Build from source

npm install
npm run dev     # watch mode
npm run build   # production build

Requires Node 16+.

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.