penDF

by Denny Kim
5
4
3
2
1
Score: 50/100

Description

penDF — a standalone, iPad-first PDF viewer and annotator for Obsidian. No other plugins required.

Reviews

No reviews yet.

Stats

0
stars
53
downloads
0
forks
5
days
3
days
3
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
58
commits

Latest Version

4 days ago

Changelog

Built from 1ddd6e83569ec4ea3991d98c419dfbcc8b7bb670. main.js 3476905 bytes. Bundles pdf.js 6.5.438 (Apache-2.0); see THIRD_PARTY_NOTICES.md. Assets carry build-provenance attestations: gh attestation verify main.js --repo dhwan0112/pendf.

README file from

Github

penDF

A standalone, iPad-first PDF viewer and annotator for Obsidian.

  • No other plugins required. It does not use, detect or patch Obsidian's built-in PDF viewer or any other plugin; it bundles its own copy of PDF.js and uses only Obsidian's public API.
  • Your PDFs are never modified. Annotations are stored next to each PDF in <name>.pdf.pendf.json — a documented format (see docs/SCHEMA.md).
  • Works offline: the PDF.js worker, CMaps (CJK), standard fonts and image decoders are embedded in main.js; nothing is fetched from the network.

Status

All six phases (viewer, highlights, notes, links, bookmarks, handwriting) plus, in 0.8.0, a margin beside the pages, area excerpts, a panel inside the view and a vault-wide annotation index, and in 0.8.2 a tool palette at the bottom of the view. See docs/REPORT.md.

Phase Feature State
1 Viewer: continuous scroll, virtualized pages, pinch/⌘-wheel zoom, fit width, rotation, text selection, search, internal/external links, per-file position memory, dark (inverted) pages done (desktop-verified, iPad checklist pending)
2 Highlights: 4 colors, multi-line / multi-column / cross-page, tap to recolor / copy / delete, undo/redo done (desktop-verified, iPad checklist pending)
3 Notes: on a highlight or a point of the page, Markdown (links, lists, tasks…), annotations panel by page done (desktop-verified, iPad checklist pending)
4 Links: copy a link to a highlight, note, selection or page; clicking it in a note opens penDF there (and the page in Obsidian's viewer without penDF) done (desktop-verified, iPad checklist pending)
5 Bookmarks: the PDF's outline, your own bookmarks (add, rename, reorder, copy link, delete) done (desktop-verified, iPad checklist pending)
6 Handwriting: uniform-width pen, highlighter, stroke eraser, undo; Apple Pencil writes, fingers scroll and select done (desktop-verified with synthetic pen input; Pencil latency and palm behaviour need an iPad)

Install

Not in the community plugin list yet. With BRAT: add dhwan0112/pendf. Or copy main.js, manifest.json and styles.css from a release into <vault>/.obsidian/plugins/pendf/.

Use

  • Just open a PDF: with Settings → penDF → Open PDFs in penDF (on by default) every PDF you open goes to penDF. The file menu offers Open in Obsidian's PDF viewer when you need the built-in one; with the setting off it offers Open in penDF instead.
  • Command palette → penDF: Open current PDF / Open a PDF…
  • Limits: PDFs embedded in notes and hover previews still use Obsidian's viewer.
  • Select text → pick a color from the palette that appears. Tap a highlight to recolor, copy or delete it. ⌘/Ctrl+Z / ⌘/Ctrl+Shift+Z undo/redo.
  • Two bars: the top toolbar is for viewing and moving around (pages, zoom, fit width, rotate, margin, bookmark, search, link, panel). The annotation tools sit in the tool palette floating at the bottom of the page area: no tool (read and select), pen, highlighter, stroke eraser, text highlight, area excerpt, note, undo/redo. Press the selected tool again for its colours, widths and (highlighter) opacity; the palette remembers them and the last tool. Fold it with its ⌄ button. Each tool has a command (Select tool: …) for hotkeys.
  • Notes: tap a highlight → note button, or the palette's note tool then tap the page. Tap a note marker to read it (Markdown), edit or delete it. Deleting a highlight deletes its notes too (undo brings both back).
  • Toolbar Annotations (or command penDF: Show annotations panel) lists the highlights and notes of the open PDF page by page; tap one to jump there.
  • Links: the link button in a highlight's menu, a note's popover, the selection palette or the toolbar (current page) copies an Obsidian link; paste it into any note. Clicking it opens penDF at that spot. Commands: Copy link to current page, Copy link to selection.
  • Panel (toolbar list button): opens inside the penDF view — beside the pages when there is room, over them otherwise (tap outside to close); drag its edge to resize. Settings → penDF → Panel location can send it to Obsidian's right sidebar instead. Tabs: Outline, Pages (thumbnails; tap to jump), Search (every match in the document with its context; tap to jump and flash it — commands Show page thumbnails, Search the whole PDF), Bookmarks (yours: the toolbar bookmark button or Bookmark this spot marks the top of the view; rename, move up/down, copy link, delete) and Annotations.
  • Handwriting: the Apple Pencil uses the palette's tool; with no tool selected it writes with the last pen tool (pen or highlighter) when Settings → penDF → Apple Pencil always writes is on (default). Fingers scroll, select text and pinch. The text tool highlights the text the Pencil drags over. If on your device the Pencil scrolls the page instead, set Settings → penDF → Pencil and finger → Everything writes. Undo/redo cover strokes too.
  • Margin (top toolbar button or Toggle margin): empty space beside each page for handwriting and notes, without covering the text. Width and side in the settings; each PDF remembers its own. A PDF with margin content opens its margin by itself; with the margin closed, a small mark on the page edge shows there is something in it. A note's Move button, then a tap, moves it (also into the margin).
  • Area excerpt (palette tool or command): drag a rectangle with the Pencil or the mouse (fingers scroll, unless Everything writes is set). Tap an area for colour, note, link, Copy image and Save image (Obsidian's attachment location); the Annotations tab shows it with a thumbnail. Only the coordinates are stored.
  • Search annotations in vault (command): highlights, notes, excerpts, bookmarks and handwriting of every PDF; filter with type:highlight / color:yellow; pick one to open it in penDF.
  • Every button has a name (hover, or press and hold on iPad); on a narrow view the less used ones move into More (⋯).
  • ⌘/Ctrl+F searches.

Obsidian Sync users: enable Settings → Sync → Sync all other types so the .pendf.json sidecars sync.

Develop

pnpm install
pnpm build          # main.js + styles.css, fails above 5 MB
pnpm test           # vitest (generates the fixtures on first run)
pnpm lint           # tsc + Obsidian ESLint rules + scripts/check-standalone.mjs
pnpm fixtures       # deterministic test PDFs → fixtures/out/ (+ manifest.json)
pnpm smoke:webkit   # PDF engine in Playwright WebKit + Chromium, outside Obsidian
                    #   (first: pnpm exec playwright install webkit chromium)
node scripts/make-test-vault.mjs             # dedicated test vault ../pendf-testvault
node scripts/obsidian-harness.mjs            # desktop end-to-end checks in that vault

The harness and install-dev only run in a vault with a .pendf-test-vault file at its root; open the test vault once in Obsidian ("Open folder as vault") before the first harness run.

Docs: CHANGELOG · INVESTIGATION · DECISIONS · BLOCKERS · DEVICE_CHECKLIST · SCHEMA · REPORT

License

MIT. Bundles PDF.js and its data files under their own licenses — see THIRD_PARTY_NOTICES.md.