https://github.com/philips/supernote-obsidian-plugin?tab=readme-ov-file
Supernote A5, A5X, A6X, A6X2 (Nomad) integration for Obsidian. Generate markdown, capture screen mirror, and more.
https://github.com/philips/supernote-obsidian-plugin?tab=readme-ov-file
eink obsidian obsidian-plugin supernote
Last synced: 5 months ago
JSON representation
Supernote A5, A5X, A6X, A6X2 (Nomad) integration for Obsidian. Generate markdown, capture screen mirror, and more.
- Host: GitHub
- URL: https://github.com/philips/supernote-obsidian-plugin?tab=readme-ov-file
- Owner: philips
- License: mit
- Created: 2024-02-27T20:05:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-09T04:09:14.000Z (over 1 year ago)
- Last Synced: 2024-08-02T10:19:44.734Z (about 1 year ago)
- Topics: eink, obsidian, obsidian-plugin, supernote
- Language: TypeScript
- Homepage:
- Size: 28.3 MB
- Stars: 97
- Watchers: 5
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-supernote - Unofficial Obsidian Plugin
README
# 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 four 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](https://support.supernote.com/en_US/organizing-managing/1791924-screen-mirroring) into your current note with the "Insert Supernote mirror image" command ([demo video](https://youtu.be/Ih_NW-z_aLw))
- ⬇️ Download & Upload files directly from your device via the Supernote [Browse & Access](https://support.supernote.com/en_US/Tools-Features/wi-fi-transfer) feature. ([demo video](https://www.youtube.com/watch?v=SEkp395hbBM))
**Video Demo**
[](https://www.youtube.com/watch?v=tEoW35fYVew)
## Install via Community Plugin Store
This plugin is available via the [Obsidian Community Plugin Store](https://obsidian.md/plugins?id=supernote). 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](https://tfthacker.com/BRAT)
- Add `https://github.com/philips/supernote-obsidian-plugin`
## Manually installing the plugin
- Copy over `main.js`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/obsidian-plugin-supernote/` from [https://github.com/philips/supernote-obsidian-plugin/releases](https://github.com/philips/supernote-obsidian-plugin)
## Known Issues
There are a handful of known issues. Please check the [issue list](https://github.com/philips/supernote-obsidian-plugin/issues). If you don't see a matching issue please [create a new issue](https://github.com/philips/supernote-obsidian-plugin/issues)?
## Roadmap / Ideas
- 🔗 Note linking
- 🎛️ Settings panel to control file layout, linking, and more
## Thank You
Thank you to [Tiemen Schuijbroek](https://gitlab.com/Tiemen/supernote) 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](https://help.obsidian.md/Plugins/Outline) sidebar accomplishes this same feature.
## Other Helpful Plugins
These are not endorsements but might be useful to pair with this plugin.
- [Mousewheel Image Zoom](https://obsidian.md/plugins?id=mousewheel-image-zoom)
- [Image Toolkit](https://obsidian.md/plugins?id=obsidian-image-toolkit)
## Relevant Resources
- [Obsidian and Supernote by Organizing for Change](https://www.youtube.com/watch?v=2zKD79e-V_U)
- [E-Ink notes in Obsidian / Notion? by Brandon Boswell](https://www.youtube.com/watch?v=kW8I8B-eCRk)
- [Academic HANDWRITTEN notes in OBSIDIAN ft. Supernote by pixel leaves](https://www.youtube.com/watch?v=lzYCPkVnqIM)
## Funding
I personally don't accept funding or donations for this project. However, if you feel inclined, consider donating to the [Signal Foundation](https://signal.org/donate/).
## 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.
**Android Debugging**
- Ensure `npm run dev` is running above
- Create a vault called "SupernoteTest"
- Install the supernote plugin from the community store
- Run `npm run push-android` to push main.js to the device
- Run "Reload App without Saving" on Obsidian command palette