obsidian-plugin/philips_supernote-obsidian-plugin
1
0
Fork 0
mirror of https://github.com/philips/supernote-obsidian-plugin.git synced 2026-07-22 09:50:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
66 commits 6 branches 39 tags 29 MiB
TypeScript 92.7%
JavaScript 3.7%
CSS 3.1%
Shell 0.5%
Find a file
Brandon Philips 0f8bc55c75
README.md: update to new URL
2024-03-31 08:18:08 -07:00
.github/workflows github: cleanup build and add deps 2024-03-30 09:49:35 -07:00
scripts github: cleanup build and add deps 2024-03-30 09:49:35 -07:00
supernote-typescript@3adba0e53d main: drop buffer dependency 2024-03-28 22:59:49 -07:00
.editorconfig Initial commit 2024-02-27 12:05:03 -08:00
.eslintignore Initial commit 2024-02-27 12:05:03 -08:00
.eslintrc Initial commit 2024-02-27 12:05:03 -08:00
.gitignore Initial commit 2024-02-27 12:05:03 -08:00
.gitmodules initial working commit 2024-03-01 12:42:02 -08:00
.npmrc Initial commit 2024-02-27 12:05:03 -08:00
esbuild.config.mjs initial working commit 2024-03-01 12:42:02 -08:00
LICENSE LICENSE: initial commit 2024-03-01 13:25:09 -08:00
main.ts main: cleanup coding style stuff 2024-03-31 07:13:54 -07:00
manifest.json 2.1.9 2024-03-31 07:30:01 -07:00
package-lock.json 2.1.9 2024-03-31 07:30:01 -07:00
package.json 2.1.9 2024-03-31 07:30:01 -07:00
README.md README.md: update to new URL 2024-03-31 08:18:08 -07:00
styles.css Initial commit 2024-02-27 12:05:03 -08:00
tsconfig.json github: cleanup build and add deps 2024-03-30 09:49:35 -07:00
version-bump.mjs Initial commit 2024-02-27 12:05:03 -08:00
versions.json 2.1.9 2024-03-31 07:30:01 -07:00

README.md

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 BRAT

  • 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

  • Doesn't seem to work on iOS

Roadmap / Ideas

  • 🔗 Note linking
  • 🎛️ Settings panel to control file layout, linking, and more
  • 🚀 Get listed in the official Obsidian community plugin list

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.

Relevant Resources

Other Helpful Plugins

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

Developer Notes

How to use

  • 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.