Anki note-sync

Sync your Obsidian vault to Anki via AnkiConnect. Creates Basic cards from your markdown notes with full control over heading levels, update behavior, and deletion.

Requirements

• Obsidian (desktop)
• Anki with the AnkiConnect add-on installed and running

Setup

1. Install AnkiConnect in Anki (Anki → Tools → Add-ons → Get Add-ons, then use the AnkiConnect code).
2. Open Anki so it is running (AnkiConnect listens on http://localhost:8765 by default).
3. In Obsidian, install this plugin (copy the plugin folder into your vault’s .obsidian/plugins/ and enable it in Settings → Community plugins).
4. Open Settings → Anki note-sync and configure:
   • AnkiConnect URL (default: http://localhost:8765)
   • Sync behavior: Replace (upsert) vs Append only; whether to remove notes in Anki that no longer exist in the vault
   • Background sync on note changes: automatically queue sync when markdown files change
   • Card extraction: Section heading level (H1–H6), intro card toggle
   • Paths & tags: Excluded folders, global tags, vault root subpath
   • Asset handling: If you store assets in a separate folder, enter the folder name here.

Usage

• The app will automatically sync when you edit a markdown file.
• Use the sync icon in the left ribbon, or run the command Sync to Anki to run a background sync.
• Progress is shown in the status bar corner while syncing.
• Use Open sync view if you want a detailed log window and manual run button.
• Sync to Anki in background (explicitly starts a queued background run).
• If “Remove notes no longer in vault” is on, you will be asked to confirm before notes are deleted.

Behavior

• Decks: All cards are synced into one parent deck configured in settings (default: Obsidian).
• Cards: Each note is split by the chosen section heading level (default H2). Each such heading becomes one Basic card (front = heading, back = content until the next same-level heading). Optionally, content before the first section becomes an “intro” card.
• Change detection: The plugin stores a per-card fingerprint and note ID. If a card is unchanged since the previous successful sync, it is skipped.
• Background queue: Multiple file changes are debounced and queued so only one sync runs at a time.
• Tags: All synced notes get the global tags you set, plus a tag derived from the file name.
• Images: Obsidian image syntax (![[image.png]], ![alt](url)) is resolved; images are uploaded to Anki and inlined.
• LaTeX: Inline and display math are preserved and normalized for Anki/MathJax.

Safety

• Deletion: Only notes that have the plugin’s global tag and belong to the configured deck prefix are considered “managed.” Only those are ever deleted when “Remove notes no longer in vault” is enabled. Use a dedicated tag (e.g. obsidian) so other Anki notes are never touched.
• Append-only mode: If you want to never change or delete existing Anki notes, set Card update mode to “Append only” and turn off “Remove notes no longer in vault.”

Building

npm install
npm run build

Output is main.js in the plugin folder. Use npm run dev for watch mode.

License

Use and modify as you like.