michellegdyason188 downloadsCitation-focused PDF annotation and note-linking for Obsidian.
PDF Scholia Scribe is a citation-focused fork of PDF++ for Obsidian. It is built for reading PDFs while writing scholarly notes: copy a passage, keep the link back to the exact PDF selection, and show a quiet citation label in the note instead of a long file/page/colour link.
The fork keeps the powerful PDF++ backlink-highlighting system, but changes the writing workflow around it:
(Deleuze 1983:124), APA or Harvard-style page citations, or numbered citations such as [1];"quoted passage" (Author year:page) with the PDF link hidden under the citation text;47 instead of the PDF viewer's internal page number;Zotero only option for noisy vaults and a Date only option for sentences where the author is already named;References section;This is still a PDF++ fork, not a replacement for Zotero. Zotero is used for citation metadata and formatted references; PDF Scholia Scribe handles the Obsidian PDF link, highlight, paste, and note-writing workflow.
PDF Scholia Scribe is the Obsidian plugin part of a larger Scholia direction: helping a research library become easier to cite, review, and turn into finished scholarly notes. The plugin will keep focusing on the moment where reading becomes writing: PDF selections, clean citation labels, Zotero metadata, reference lists, and links that still point back to the exact passage.
The next work is aimed at making that workflow calmer and more dependable:
Scholia is the broader research-library project around this plugin. Where PDF Scholia Scribe works inside Obsidian while you read and write, Scholia is intended to help with the wider scholarly workflow: keeping sources organised, improving metadata, finding gaps in a literature set, and moving from collected PDFs toward usable arguments and bibliographies.
PDF Scholia Scribe is maintained by Michelle G Dyason. It is a fork of PDF++, with extra tools for quieter scholarly notes, citation-like PDF links, Zotero-backed citations, date-only citations, labelled callouts, and reference-list generation.
PDF Scholia Scribe is a maintained fork of PDF++, and a large part of the inherited PDF viewer integration is still based on PDF++ compatibility code. The compatibility layer lives mainly in src/patchers/ and src/typings.d.ts; it touches Obsidian PDF viewer and PDF.js surfaces that are not all covered by stable public APIs. Those paths are guarded defensively, but PDF viewer internals can change between Obsidian releases.
Zotero support is local-first. When you use Zotero citation search or reference-list generation, the plugin may query the Zotero local API at the configured base URL, which defaults to http://127.0.0.1:23119. It uses Obsidian's requestUrl first, and on desktop can fall back to a local Node HTTP request to the same localhost endpoint if the browser-style request path cannot reach Zotero. It does not contact Zotero cloud by default.
The citation workflow also reads vault Markdown notes to match source metadata, citation keys, Zotero item keys, and PDF quote links. Copy, paste, outline-copy, citation, debug export, and debug import commands can write to or read from the system clipboard when the user explicitly invokes those actions.
PDF editing features are optional. If enabled, commands such as writing highlights or links into a PDF, changing annotation colors, deleting annotations, inserting pages, deleting pages, or extracting pages can modify PDF files in the vault. Keep backups of important PDFs before using direct PDF-writing features, especially with heavily annotated files from other PDF apps.
The manifest is not marked desktop-only because the core PDF link, highlight, and copy workflows are intended to run on mobile too. Desktop-only behavior is guarded in code: opening PDFs with the operating-system default app, Electron file dialogs or file-path access, direct filesystem adapter cleanup, and the Zotero local Node fallback are disabled or skipped outside the desktop app.
PDF Scholia Scribe starts from the central PDF++ idea: a Markdown link to a PDF selection can become a highlight in the PDF viewer. That is useful because the note remains ordinary Markdown, while the PDF still shows where the quoted passage came from.
The main change in this fork is how those links look and behave while writing. The original copied link could expose a lot of technical detail: file names, PDF page indexes, colour names, and source markers. PDF Scholia Scribe keeps the same link target, but lets the visible label read like a citation. A copied passage can therefore sit naturally in prose, for example:
"Since the strong could prevent themselves from acting, the weak could act if they did not prevent themselves" (Deleuze 1983:123).
Changes made in this fork so far include:
In-text citation, Quote, or Quote in callout is respected when you click a colour;The fork also adds a small Zotero-and-vault citation workflow. You can run Insert citation from Zotero or vault, search for a source, choose whether to search Zotero, the vault, or both, and insert either an author-date citation or a date-only citation. Date-only citations are useful when the sentence already names the author, for example:
Pires argues that urban agriculture needs planning support (2011:47).
For notes with many citations, Update reference list for current note creates or refreshes a managed reference list at the end of the note. The updater recognises citations inserted by PDF Scholia Scribe, ordinary @citekey references, links to vault source notes, and PDF quote links that can be matched to a source note.
These Zotero features are separate from PDF++'s original Citations in PDF (experimental) section. That original feature is for citation links already inside a PDF. PDF Scholia Scribe's added citation workflow is for writing in your Obsidian note, using Zotero metadata and your vault source notes.
This is an Obsidian.md plugin for a better PDF experience. Specifically:
PDF++ stands out among other PDF annotation tools for the following reasons:
I'm not a fan of
.mdfiles that are actually not markdown at all. The value of the markdown format does not lie in the file extension!
&color=.../&rect=... link parameters).🚀 Install
📖 Read the docs (Note: it's still a work in progress!)
💬 Ask & answer questions
❗ Report bugs (Tip: when something is not working, first restart Obsidian by running the Reload app without saving command.)
[!note]
- Some features require the Style Settings plugin enabled.
- If you're an Android user and have trouble with PDF++, first try updating Android System WebView (if you are on Android 7-9, update Chrome instead).
[!warning] This plugin retains PDF++'s private PDF viewer compatibility layer, so there is still a risk that some PDF-viewer features may break when Obsidian changes its built-in PDF internals (background).
Here I'm just scratching the surface of what PDF++ can do. See below and the plugin settings in Obsidian for more details. Also note that each feature can be toggled on and off in the plugin settings, which lets you customize this plugin to best fit into your use case.
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/0a9c267d-b74a-4568-821b-a659e29fdac0
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/72072345-3537-42e7-ad06-5e4a166f83f4
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/8ef3bc62-70d7-449a-b6a7-0370a2b4a8d8
It's also friendly to laptops with small display sizes. See here for the details.
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/cb292049-bd89-4cd1-9d72-a02828d765e0
See here for the details.
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/fb624769-4cc3-4d4e-9898-b17d0a5591e3
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/7a6331ab-71bf-45d0-a457-7984e487e326
Ctrl/Cmd+hover over highlights to preview or open backlinksDepends on the Action when hovering over highlighted text setting.
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/ea14d06a-70f6-45cf-a142-0213adb9749b
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/5f3dded8-79ad-44cc-816f-dc697dc4a343
Show only backlinks to the page that is currently opened in the PDF viewer.
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/4147e634-7864-40b4-b916-a6db40b85f31
https://github.com/RyotaUshio/obsidian-pdf-plus/assets/72342591/2285a837-0588-4a72-8193-da25a456bf84
Each feature can be toggled on and off in the plugin settings.
Annotate PDF files with highlights just by linking to text selection. You can easily copy links to selections using color palette in the toolbar. See the "Color palette" section for the details.
&color=<COLOR NAME> to a link text to highlight the selection with a specified color.<COLOR NAME> is one of the colors that you register in the plugin settings. e.g [[file.pdf#page=1&selection=4,0,5,20&color=red]]&color=red, &color=RED and even &color=rEd work the same.&color=... appended automatically. See the "Color palette" section for the details.Ctrl/Cmd (by default) while hovering over a highlighted text in PDF viewer: you can choose what happens when you hover over a highlighted text between the following:Create callouts with the same color as the highlight color without any CSS snippet scripting.
These features make Obsidian a unique PDF annotation tool that tightly connects PDFs to your ideas stored as markdown files.
Add, edit, and delete highlights and links in PDF files. Added annotations will be visible even outside Obsidian, unlike backlink highlights.
PDF++ will not modify PDF files themselves unless you explicitly allow it. The author assumes no responsibility for any data corruption. Please make sure you have a backup and use it at your own risk. Report any issues you encounter here.
Add, insert, remove or extract PDF pages via commands and automatically update related links in the entire vault.
Allow PDF modification and right-click on the PDF outline. Alternatively, you can use the command "Add to outline" to add a new item, or drag & drop outline items to move it under another item.
Make it easier to work with internal links embedded in PDF files.
Ctrl/Cmd while hovering a PDF link to actually open it if the target PDF is already opened in another tab.height parameter in popover preview: Obsidian lets you specify the height of a PDF embed by appending &height=... to a link, and this also applies to popover previews. Enable this option if you want to ignore the height parameter in popover previews.&color=... appended.Copy link to selection or annotation command: This command allows you to trigger the copy-link action specified in a dropdown menu in the PDF toolbar quickly via a hotkey. I recommend using Ctrl+Shift+C/Cmd+Shift+C.Copy & auto-paste link to selection or annotation command: In addition to copying a link, this command automatically pastes the copied link at the end of the note where you last pasted a link.Note: these commands cannot be triggered from the Command Palette. Make sure that you set custom hotkeys for them.
Toggle "select text to copy" mode icon in the left ribbon menu: While it's turned on, the Copy link to selection or annotation command will be triggered automatically every time you select a range of text in a PDF viewer, meaning you don't even have to press a hotkey to copy a link.See here for the details.
You can customize the template format used when copying a link to a selection or an annotation in PDF viewer. Each {{...}} in the template resolves a supported template variable, such as {{linkWithDisplay}}, {{textMarkdown}}, or {{citation.harvard}}. See the plugin settings for the details.
Customize the behavior of Obsidian's built-in right-click menu in PDF view.
|<PDF FILE TITLE>, page <PAGE NUMBER> to the link text by default. This plugin allows you to disable this behavior if you don't like it.Note: The Minimal theme has an issue where thumbnails cannot be right-clicked to open a menu when combined with Style Settings (details).
Note: When disabled, drag-and-drop will cause the thumbnail image to be paste as a data url, which is seemingly Obsidian's bug.
PDF++ offers the following commands for reducing mouse clicks on the PDF toolbar by assigning hotkeys to them.
You can customize the styling of various components of PDF++ using CSS snippets.
Here is a list of CSS selectors to target:
.textLayer .mod-focused: Obsidian's native text selection highlights shown when opening links to text selections in PDFs.annotationLayer .mod-focused: Obsidian's native annotation highlights shown when opening links to annotations in PDFs.pdf-plus-backlink-highlight-layer .pdf-plus-backlink: PDF text highlights that PDF++ generates from backlinks.pdf-plus-backlink-highlight-layer .pdf-plus-backlink[data-highlight-color="<COLOR NAME>"] to target a specific color.pdf-plus-backlink-highlight-layer .pdf-plus-backlink.hovered-highlight: PDF text highlights that PDF++ generates when you hover over an item in the backlinks paneThe highlight colors that you define in the Highlight colors setting are also available as CSS variables.
For example, a color named "Yellow" will be converted into a variable --pdf-plus-yellow-rgb. Its value is a tuple of the RGB values, e.g. 255, 208, 0.
Note that non-alphanumeric characters are replaced with hyphens in variable names. For example, a color with name "Super LONG name!!" will result in a variable name --pdf-plus-super-long-name-rgb.
Additionally, the color specified in the Default highlight color setting is also available as --pdf-plus-default-color-rgb.
You can use these CSS variables for various purposes. For example, you can create a callout whose color matches the highlight color in the PDF viewer.
[!NOTE] Update: Now you have the "PDF++ callouts" feature, which allows you to get the same result without writing CSS snippets on your own.
Here we use a callout type "PDF" as an example, but it can be anything you like.
Copy format:
> [!PDF|{{colorName}}] {{linkWithDisplay}}
> {{text}}
Result example:
> [!PDF|yellow] [[file.pdf#page=1&selection=0,1,2,3&color=yellow|file, page 1]]
> Lorem ipsum
> [!PDF|red] [[file.pdf#page=1&selection=0,1,2,3&color=red|file, page 1]]
> Lorem ipsum
> [!PDF|] [[file.pdf#page=1&selection=0,1,2,3|file, page 1]]
> Lorem ipsum
or without pipe ("|") after the callout type ("PDF"):
> [!PDF] [[file.pdf#page=1&selection=0,1,2,3|file, page 1]]
> Lorem ipsum
CSS snippet:
.callout[data-callout="pdf"][data-callout-metadata="yellow"] {
--callout-color: var(--pdf-plus-yellow-rgb);
}
.callout[data-callout="pdf"][data-callout-metadata="red"] {
--callout-color: var(--pdf-plus-red-rgb);
}
.callout[data-callout="pdf"] {
--callout-color: var(--pdf-plus-default-color-rgb);
}
Another approach is to associate each highlight color to a specify callout type such as "Note" or "Important".
Copy format:
> [!{{colorName}}] {{linkWithDisplay}}
> {{text}}
Result example:
> [!note] [[file.pdf#page=1&selection=0,1,2,3&color=note|file, page 1]]
> Lorem ipsum
> [!important] [[file.pdf#page=1&selection=0,1,2,3&color=important|file, page 1]]
> Lorem ipsum
CSS snippet:
.callout[data-callout="note"] {
--callout-color: var(--pdf-plus-note-rgb);
}
.callout[data-callout="important"] {
--callout-color: var(--pdf-plus-important-rgb);
}
Sometimes, you may find page preview popovers too tall.
For example, suppose you're reading a LaTeX-generated paper. You can hover over an inline citation (e.g. "Author et al., 2024") to show a popover preview of the corresponding entry in the bibliography section (see [[Citation links]]). Since a bib entry is usually not that tall, the popover often has too much vertical space.
Now, use the following CSS snippet to remove the extra space:
.popover.hover-popover.pdf-plus-pdf-internal-link-popover[data-dest^="cite."] {
--popover-pdf-height: 100px; /* Change this to your liking */
}
The data-dest attribute is the ID of the named destination (i.e. link target) that the internal link points to, which typically starts with cite. for bibliographic items.
In general, you can get the ID by the following steps:
command+option+I (macOS) / Ctrl+Shift+I (windows) to open the developer tool.<a> element will be highlighted in the "Elements" tab of the dev tool.href attribute of the <a> element is the destination ID with a hash sign (#) prepended.You can also find a great tutorial on the forum.
Although PDF++ is primarily designed with backlink highlighting (= annotation by backlink) in mind, it is also possible to add annotations directly inside PDF files. However, you will notice some limitations, including the viewer being reloaded every time you add a highlight to your file. Therefore, this feature should be considered to be a temporary workaround until Obsidian itself supports PDF annotation, which is on their roadmap.
Update 2024-08-20: I've just found a new plugin called Pdf Annotator. For now, it does not save annotations in PDF itself. However, it says it will be able to do so once Obsidian's PDF.js version is updated to 4.x. For those who prefer in-file annotations to backlink highlighting, this might be a better solution. Fortunately, it seems to be compatible with PDF++, meaning you can use features from both of two plugins at the same time although some of PDF++ features (e.g. hover over a highlight to preview backlinks, double-click on a highlight to open backlinks, etc.) are not available for annotations made by the Pdf Annotator plugin.
When approved, you will be able to install this plugin from within Obsidian's community plugin browser.
Alternatively, you can install the current GitHub release directly from this repository using BRAT.
Auto-update plugins at startup at the top of the page.obsidian://brat?plugin=MichelleGDyason/pdf-scholia-scribe.You can also add the plugin in BRAT with this repository slug:
MichelleGDyason/pdf-scholia-scribe
PDF++ is built on top of Obsidian's native PDF viewer powered by Mozilla's PDF.js, which is already pretty good even without PDF++. Without the awesome work of the Obsidian team and the PDF.js maintainers, PDF++ would not have been possible.
PDF++ extends the native viewer by using monkey-around, an awesome patching library by PJ Eby. It is used by countless Obsidian plugins and has been helping the community as an infrastructure providing a foundation of Obsidian's high extendability. He's also the author of several popular Obsidian plugins including Tag Wrangler.
PDF++ offers two ways to highlight text in PDF: one that does not involve modifying the PDF file, and the other that writes highlight annotations directly into the PDF file. The latter is powered by the pdf-lib, a JavaScript library for creating and modifying PDF documents. The original project was created by Andrew Dillon. PDF++ uses a forked version maintained by Cantoo Scribe.
PDF++ also supports Vim-like keybindings. Its design was inspired by codemirror-vim and Tridactyl. Especially, some code for the link mode was borrowed from Tridactyl, which is distributed under the Apache 2.0 License by Colin Caine, Oliver Blanthorn and Koushien with some modification.
I'm trying to keep PDF++ compatible with the following plugin(s) as much as possible:
The following plugin(s) alters Obsidian's internals in such a way that prevents some aspects of other plugins from working properly, so I don't recommend using it together with this plugin.
If PDF Scholia Scribe supports your reading and writing, you can support Michelle's work here: