Simple Anki Sync - Obsidian Plugin

⚠️ Prerequisite: Anki must be running with the AnkiConnect extension installed and active.

• Install from AnkiWeb
• More details: AnkiConnect homepage

Simple Anki Sync for Obsidian delivers the most straightforward way to keep your flashcards in sync without ever breaking your flow. By using a single, minimal Markdown-table format and supporting only Basic cards, you’ll spend zero time tweaking settings and 100 % of your time learning.

With a single command, you can instantly push your notes to AnkiConnect—no background daemons, no surprises. Just run a command to sync the entire vault or your current file, and watch your flashcards update in seconds. Study smarter, stay focused, and let the plugin handle the rest.

For useage make sure Anki is running & User the following commands:
Sync current file With Anki
Sync entire vault With Anki

---

Automatic installation via the Obsidian App (Recomendet)

https://github.com/user-attachments/assets/aebca7a1-14c3-4023-b27a-eade3b551b3c

Manual installation (not recomendet)

1. Open Terminal in Obsidian Plugins Folder:

   • Navigate to your Obsidian vault's plugin folder in your terminal or command prompt. This is usually located at: <YourVault>/.obsidian/plugins/
   • For example:

     cd path/to/your/vault/.obsidian/plugins/
     

2. Clone the Repository:

   • Clone this repository directly into the plugins folder:

     git clone https://github.com/lukmay/simple-anki-sync.git
     

3. Navigate into Plugin Folder & Build:

   • Change directory into the newly cloned plugin folder:

     cd simple-anki-sync
     

   • Run the following commands to install dependencies and build the plugin:

     npm install
     

     Then:

     npm run build
     

     This will create the necessary main.js file within the simple-anki-sync folder.

4. Enable in Obsidian:

   • Ensure Anki is running. (And the AnkiConnect add-on is installed and configured in Anki).
   • Restart Obsidian or reload its plugins (e.g., by toggling "Community Plugins" off and on).
   • Go to Settings > Community plugins in Obsidian.
   • Find "Simple Anki Sync" in the list and toggle it on.

---

Main Feature: Obsidian → Anki Sync

Commands:
Sync current file With Anki
Sync entire vault With Anki
Unsync current file with Anki

Sync any minimal Markdown table from Obsidian into Anki as Basic cards. Just tag your note with the deck name and subdeck:

#anki/MyDeck/Subdeck

Then write your cards in this format:

| Front |
| ----- |
| Back  |

You can even include line breaks and images in-editor:

| Front with math: $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$      |
| -------------------------------------------------------------- |
| Back<br><br>With newlines, and images<br>![[example_tree.png]] |

In Anki:

Run the Sync Anki Cards command, and your cards—with proper deck/subdeck handling—appear in Anki instantly.

---

Unsync Feature

You can cleanly unsync the currently active file from Anki using the Unsync current file with Anki command.
This removes all Anki note references from the file and deletes the corresponding notes in Anki via AnkiConnect, without affecting any other files in the vault. This makes it easy to intentionally remove a note (or an entire file) from Anki while keeping your Obsidian content intact.

---

Quality-of-Life Features

• Deck renaming
  Rename your #anki/… tag and on next sync all existing cards move into the new deck automatically.
• Image support & resizing
  Embed images on either side using ![[image.png]] and control their display size inline eg. ![[image.png|300]].
• Excalidraw support
  Embed .excalidraw drawings seamlessly. They are automatically converted to images on sync.
• Math auto-formatting
  Dollar-delimited LaTeX in Obsidian becomes nicely rendered in Anki.
• Automatic deletion Delete a card in Obsidian and the corresponding Anki card is removed on sync. IMPORTANT: don't delete the Anki-ID below manually
• Precise Backlinks
  Each card carries a URL back to its source note. Clicking it from Anki will open Obsidian and scroll you down directly to the flashcard's exact row!
• Anki-Tags
  Each card in Anki has a assigned tag obsidian_simple_anki_sync_created to easely filter for this automatically created cards.

---

Video Showcase :)

https://github.com/user-attachments/assets/790abb16-b7ea-43d2-995c-720ac1c9b2ed

Quantum Mechanics Cheat Sheet

---

#anki/Physics/Quantum <-- never forget to set a deck!

Welcome to your quantum mechanics flashcards. Write each card as a minimal Markdown table, then run Sync Anki Cards.

---

Card Examples

1. Basic definition

What is the Heisenberg uncertainty principle?
It states that you cannot simultaneously know the exact position and momentum of a particle.

2. Math formatting

Solve for $x$ in the quadratic formula: $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$
Use the plus/minus to get both roots: $x_1 = \frac{-b + \sqrt{b^2 - 4ac}}{2a},; x_2 = \frac{-b - \sqrt{b^2 - 4ac}}{2a}$

3. Line breaks & images

What does a particle-in-a-box wavefunction look like? Label the nodal points.
See diagram: ![[particle_box.png]] The (n)th state has (n-1) nodes.

Note you can set the size of images as following:
![[particle_box.png]] <-- default
![[particle_box.png|200]] <-- resized

---

Deleting Cards

To remove a card from Anki, simply delete its table (or row) here. On next sync, the card will vanish from Anki too.

---

Backlinks

Every card you sync will carry a URL back to this note so you can jump right back to your source.

---

Happy studying!