AwesomeDog / obsidian-awesome-flashcard

Handy Anki integration for Obsidian.
MIT License
30 stars 5 forks source link

Awesome Flashcard

Plugin to sync flashcards in your Obsidian notes to Anki.

Design philosophy

Features

Flashcard example

In your Obsidian note:

---
A simple flashcard: Question in the front #flashcard
Answer in the back
---

will generate an Anki flashcard like this:

A simple flashcard: Question in the front
Answer in the back

see more examples in sample.md

One time setup

These steps only need to be done once.
After that ensuring Anki running would suffice to scan vault with the plugin.

  1. Start up Anki, and navigate to your desired profile.
  2. Ensure that you've installed AnkiConnect.
  3. Have Obsidian installed
  4. Search the 'Community plugins' list for this plugin
  5. Install the plugin.
  6. In Anki, navigate to Tools->Addons->AnkiConnect->Config, and change it to look like this, then restart Anki to apply the changes:
{
    "apiKey": null,
    "apiLogPath": null,
    "webBindAddress": "127.0.0.1",
    "webBindPort": 8765,
    "webCorsOrigin": "http://localhost",
    "webCorsOriginList": [
        "http://localhost",
        "app://obsidian.md"
    ]
}

How to use

Make sure Anki is running, on left sidebar's Ribbon there is an Anki icon like this:

Click it and the plugin will do the rest for you. Process is shown on Notice and in the Obsidian Developer Console

Synchronization mechanism clarified

To fulfill these goals:

The synchronization is designed as follows: