Xournal++

A seamless integration with Xournal++. Xournal++ is an open-source and cross-platform note taking application for digital, handwritten notes and PDF annotations.

Features

• Automatically export Xournal++ notes to PDF whenever they are modified, so that they can be linked, embedded, and viewed in Obsidian
• Easily create new Xournal++ files (.xopp) directly from within Obsidian, accessible from the ribbon icon, file explorer, and command palette
• Access the "Edit in Xournal++" option via an icon in the PDF preview as well as in file explorer (by clicking on X++), enabling quick navigation to the corresponding Xournal++ file.

Prerequisites

Ensure you have Xournal++ installed on your device.

If you run into any issues, you might have to manually add the Xournal++ installation path, refer to Setting the Xournal++ Installation Path for more information.

Usage

Be mindful that any PDF files sharing the same name and location as Xournal++ (.xopp) files will be overwritten with the exported version. This ensures seamless integration and consistent file management within Obsidian (regular vault backups are therefore recommended).

1. Open Obsidian and got to Settings → Community Plugins
2. Turn on Community Plugins
3. Select Browse and search for Xournal++
4. Select Install and then Enable
5. The plugin is now installed. Select Options if you want to change the default plugin settings.

Contributing and Feature Requests

Your feedback, contributions, and feature requests are valuable to the development of the plugin. Please submit any issues or suggestions via the GitHub repository.

Contributions in any form are welcome. To contribute, create a pull request and feel free to reach out to me at any time.

Local development

First, fork this repository, then run the following commands:

cd YOUR-OBSIDIAN-VAULT/.obsidian/plugins/
git clone git@github.com:YOUR-REPOSITORY
mv obsidian-xournalpp xournalpp
cd xournalpp
git checkout -b feature-branch
npm install
npm run dev

Developer

This plugin is created by Jon Jampen. I hope you find this plugin useful!