Skip to content

Supernote A5, A5X, A6X, A6X2 (Nomad) integration for Obsidian. Generate markdown, capture screen mirror, and more.

License

Notifications You must be signed in to change notification settings

philips/supernote-obsidian-plugin

Repository files navigation

Supernote Obsidian Plugin

I use my Supernote for capturing hand written notes and reading documents.

But, I already use Obsidian for organizing and capturing all of my digital notes.

This plugin enables me (and now you!) to import handwritten notes into Obsidian and view them on a desktop, phone or tablet.

This plugin has three main features:

  • 📝 View Supernote *.note files in your Obsidian Vault. You can link to these notes from your Markdown notes too [My Note](example.note).

  • ➡️ Export Supernote *.note files as PNGs and/or markdown files and attach them to your Vault.

  • 📺 Copy an image from a Supernote via screen mirroring into your current note with the "Insert Supernote mirror image" command (demo video)

Video Demo

Watch the video

Install via Community Plugin Store

This plugin is available via the Obsidian Community Plugin Store. Click the previous link or search for "Unofficial Supernote by Ratta Integration".

Install via BRAT

To test Beta builds of this plugin follow these steps:

  • Install the BRAT plugin via Community Plugin Search
  • Read the docs
  • Add https://github.com/philips/supernote-obsidian-plugin

Manually installing the plugin

Known Issues

There are a handful of known issues. Please check the issue list. If you don't see a matching issue please create a new issue?

Roadmap / Ideas

  • 🔗 Note linking
  • 🎛️ Settings panel to control file layout, linking, and more

Thank You

Thank you to Tiemen Schuijbroek for developing the initial supernote Typescript library I forked.

FAQ

Q Why isn't there a table of contents in the generated Markdown file?

A Because the Obsidian Outline sidebar accomplishes this same feature.

Q Can the images be larger or smaller?

A Add a number, in pixels, after a | in the link like ![[20240419_100426-0.png|100]]. See Obsidian docs. Also, you can use the mouse wheel zoom plugin suggested below to make this easier.

Other Helpful Plugins

These are not endorsements but might be useful to pair with this plugin.

Relevant Resources

Funding

I personally don't accept funding or donations for this project. However, if you feel inclined, consider donating to the Signal Foundation.

Developer Notes

  • Make sure your NodeJS is at least v16 (node --version).
  • Clone this repo.
  • Setup the deps
git submodule init
git submodule update
cd supernote-typescript/
npm run build
npm link
cd ..
npm link supernote-typescript/
  • npm i or yarn to install dependencies.
  • npm run dev to start compilation in watch mode.