Skip to content

Commit

Permalink
Improved instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
alberti42 committed Nov 1, 2024
1 parent 18334bb commit 0a1e30c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
# Obsidian Bibdesk Integration

The plugin provides integration of the macOS [BibDesk](https://en.wikipedia.org/wiki/BibDesk) application with the [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus) plugin for Obsidian. The plugin relies on a BibTex file for the paper library.
⚠️ The plugin is able to parse BibTex files in general, but for the momement it has been specialized and tested for BibTex libraries created with BibDesk application for MacOS.

The plugin is able to parse the `bdsk-file-XYZ` fields created by BibDesks in the BibTex library. The strength of BibDesks `bdsk-file-XYZ` links is that they are macOS bookmarks that will resolve to the correct file even if the file is later renamed or moved.
The plugin provides integration of the macOS [BibDesk](https://en.wikipedia.org/wiki/BibDesk) application with the [PDF++](https://github.com/RyotaUshio/obsidian-pdf-plus) plugin for Obsidian. The plugin relies on a BibTex file for the paper library.

The plugin is able to parse the `bdsk-file-<NUMBER>` fields created by BibDesks in the BibTex library. The strength of BibDesks `bdsk-file-<NUMBER>` links is that they are macOS bookmarks that will resolve to the correct file even if the file is later renamed or moved.

The plugin supports external BibDesk libraries. It relies on PDF++ to open the attached PDF as files external to Obsidian vault.

The plugin does not require the paper library to be stored in the vault. This is especially important for those who have a large paper library of several GB and do not intend to use space in Obsidian's vault.

The plugin provides its own fast parser for BibTex files, which is faster than existing parsers available on the internet for TypeScript. It is also faster than BibDesk original parser. Importantly, BibTex files are parsed in a separate thread preventing latency when loading Obsidian.

Below is a screenshot of the configuration pane:

![setting_screenshot](docs/images/setting_screenshot.jpg)

Below is a screenshot of the fuzzy search modal window to select a paper to open:

![setting_screenshot](docs/images/suggestion_menu_screenshot.jpg)

We suggest customizing the commands with the following hotkeys:

![hot_keys](docs/images/recommended_hotkeys.jpg)

## Installation

From command line:
Expand Down
Binary file modified docs/images/setting_screenshot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0a1e30c

Please sign in to comment.