obsidian-plugin/jonjampen_obsidian-xournalpp
1
0
Fork 0
mirror of https://github.com/jonjampen/obsidian-xournalpp.git synced 2026-07-22 05:12:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
116 commits 5 branches 18 tags 482 KiB
TypeScript 96.6%
JavaScript 2.1%
CSS 1.3%
Find a file
Jon Jampen 1506740f68 chore: change plugin name to adhere to new naming convention
2026-05-27 22:58:13 +02:00
.github/ISSUE_TEMPLATE Added installation method to bug report template. 2025-04-08 16:23:19 +02:00
docs Adding information to documentation for setting the installation path if both Obsidian and Xournal++ are installed through Flatpack (Closes #2). 2024-10-02 07:29:12 +02:00
src Default name setting with shorthands (PR #23) 2025-12-07 20:40:32 +01:00
.editorconfig Initial commit 2024-05-02 12:48:01 +02:00
.eslintignore Initial commit 2024-05-02 12:48:01 +02:00
.eslintrc Initial commit 2024-05-02 12:48:01 +02:00
.gitignore Removing styles.css and adjusting gitignore. 2024-05-06 12:31:30 +02:00
.npmrc Initial commit 2024-05-02 12:48:01 +02:00
.test.autosave.xopp Template creation and management modals (#25) 2025-11-24 08:06:09 +01:00
CHANGELOG.md Version 1.1.2: Preparing release. 2025-06-21 08:49:00 +02:00
esbuild.config.mjs Initial commit 2024-05-02 12:48:01 +02:00
LICENCE.md Adding license. 2024-05-10 11:21:07 +02:00
main.ts Default name setting with shorthands (PR #23) 2025-12-07 20:40:32 +01:00
manifest.json chore: change plugin name to adhere to new naming convention 2026-05-27 22:58:13 +02:00
package.json Default name setting with shorthands (PR #23) 2025-12-07 20:40:32 +01:00
README.md Added callout to readme 2025-05-16 07:56:02 +02:00
styles.css Default name setting with shorthands (PR #23) 2025-12-07 20:40:32 +01:00
template Fixed issue with double slash after creating a new Xournal++ file 2025-05-08 17:07:13 +02:00
template.xopp Adding feature to create a new Xournal++ note from the command palette. 2024-05-03 18:14:44 +02:00
template.zip Fixed issue with double slash after creating a new Xournal++ file 2025-05-08 17:07:13 +02:00
tsconfig.json Initial commit 2024-05-02 12:48:01 +02:00
version-bump.mjs Initial commit 2024-05-02 12:48:01 +02:00
versions.json Version 1.1.2: Preparing release. 2025-06-21 08:49:00 +02:00

README.md

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!