Skip to content

Repository files navigation

Supersidian

An Obsidian plugin that converts Supernote handwritten .note files into markdown using AI vision APIs — bring your own API key.

How it works

  1. Watches a folder on your computer where Supernote files are synced (via Supernote Cloud, Dropbox, or any other method)
  2. Renders each page of a .note file as an image using the supernote-typescript library
  3. Sends each page image to your chosen AI provider for handwriting recognition
  4. Saves the transcribed text as a markdown note in your vault, with YAML frontmatter recording the source file and which model did the transcription

Features

  • Bring your own API key — supports OpenAI (GPT-4o), Anthropic (Claude), and Google Gemini
  • Incremental sync — only new or changed files are processed; previously transcribed notes are skipped
  • Automatic polling — checks for new files every 60 seconds in the background
  • Multi-page support — each page becomes a ## Page N section in the note
  • Built-in fallback — if the AI call fails, falls back to the Supernote device's own handwriting recognition (if enabled on the device)
  • Optional image embeds — save rendered page images alongside the transcribed text
  • Customisable AI prompt — edit the prompt to control output language, formatting style, and more
  • Frontmatter provenance — every note records transcribed_by so you always know whether AI or the device's built-in recognition was used
  • NEW: Task sync — Syncs your Supernote ToDos and saves them to a specified file in your vault, tags them #task for use with the Tasks Obsidian Plugin. (You can change the tag as well.)

Requirements

  • A Supernote device (A5X, A6X, A6X2 Nomad, A5X2 Manta, or compatible)
  • Supernote files synced to your computer (via Supernote Cloud, Dropbox, syncthing, USB, etc.)
  • An API key from one of the supported AI providers:
  • Obsidian desktop (this plugin uses Node.js file system APIs and is not available on mobile)
  • For ToDo sync - a Supernote account and password

Installation

You can install via BRAT and this repo. Just copy the Github URL into Bart, and enable.

Manual installation

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Copy them into <your vault>/.obsidian/plugins/supersidian/
  3. Reload Obsidian and enable the plugin under Settings → Community plugins

Configuration

Open Settings → Supersidian after enabling the plugin.

Setting Description
Supernote watch folder Absolute path to the folder where your .note files are synced, e.g. /Users/you/SupernoteCloud/Note
Output folder Vault-relative folder where transcribed notes are saved. Default: Supernote
Note title template {{filename}} and {{date}} (YYYY-MM-DD) are available as variables
Embed page images Also save rendered page images alongside the text in the note
Provider OpenAI, Anthropic, or Google Gemini
API key Your key for the selected provider
Model Leave blank to use the provider default, or enter a specific model name
AI prompt The instruction sent with each page image. Customise to change language, tone, or formatting conventions

Usage

The plugin checks for new or changed .note files automatically every 60 seconds. You can also trigger it manually:

  • Settings panel → click Process new files
  • Command paletteSupersidian: Process new Supernote files

To re-transcribe files that have already been processed (e.g. after changing your AI prompt):

  • Settings panel → click Reprocess all
  • Command paletteSupersidian: Force reprocess all Supernote files

Output format

Each transcribed note includes YAML frontmatter:

---
source: "MyNote.note"
created: 2026-05-28
transcribed_by: anthropic/claude-sonnet-4-6
tags:
  - supernote
---

Multi-page notes are separated by ## Page N headings and horizontal rules.

Privacy

Your .note file pages are rendered locally on your machine and sent as images directly to your chosen AI provider's API. No data passes through any Supersidian server. Your API key is stored in your vault's local plugin data (data.json) and never transmitted anywhere other than the provider's API endpoint.

License

MIT

About

An Obsidian plugin that monitors a specified folder for synced Supernote .note files, automatically reconigizes new notes, uses your own AI API to transcribe the notes (uses Supernote OCR as a fall-back), and saves clean MD to a folder on your machine.

Resources

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages