README file from
GithubXournal++ Integration for Obsidian
A seamless integration with Xournal++. Xournal++ is an open-source, cross-platform note-taking application for digital, handwritten notes and PDF annotations. This plugin bridges Xournal++ with your Obsidian vault.
Install Plugin | Documentation Site | Report an Issue | Discord
Features
- 🔄 Automatic PDF Export: Automatically exports Xournal++ notes (
.xopp) to PDF whenever they are modified, allowing them to be linked, embedded, and viewed inside Obsidian. - ➕ Easy Creation: Create new Xournal++ files directly from the ribbon icon, file explorer context menu, or command palette.
- ⚡ Direct Editing: Click the edit icon in the PDF toolbar or select "Edit in Xournal++" from the file explorer context menu to instantly open the file in Xournal++.
- 🎨 Custom Templates: Configure default page sizes, grid backgrounds, and custom colors when creating new notes.
How to Install
- Install Xournal++ on your system.
- In Obsidian, go to Settings → Community Plugins and turn them on.
- Select Browse, search for
Xournalpp, and click Install then Enable. - Configure the path where Xournal++ is installed on your system in the plugin settings (leave empty if installed in the default system path).
[!IMPORTANT] Any PDF files sharing the exact same name and location as a Xournal++ (
.xopp) file will be overwritten with the exported version when modified. Ensure your vault is backed up.
Contributing
Contributions are welcome! For guidelines on how to contribute code, report bugs, or request features, please see our Contributing Guide in the documentation.
Maintainer
This plugin is created and maintained by Jon Jampen. Thanks to the contributors for their valuable input and improvements. I hope you find this plugin useful!