Skip to content

jonjampen/obsidian-xournalpp

Repository files navigation

Xournal++

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

Install Plugin | Documentation | GitHub | Discord

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.

Usage

Important

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. Ensure you have Xournal++ installed on your device
  2. Open Obsidian and got to Settings → Community Plugins
  3. Turn on Community Plugins
  4. Select Browse and search for Xournal++
  5. Select Install and then Enable
  6. The plugin is now installed. Select Options if you want to change the default plugin settings.

You can head over to the documentation for more information on how to use the plugin and customize the settings.

⚠️ Breaking Changes

Release v1.1.0 introduced a breaking change: if you have a space in your custom Xournal++ Installation path, be sure to add double quotes around it ("). Also see: Release Notes

Developer

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!

About

Obsidian plugin that seamlessly integrates Xournal++ for handwritten notes and annotations.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 5