/flashcards-obsidian

🎴 An Anki plugin for Obsidian.md

Primary LanguageTypeScriptMIT LicenseMIT

Changes from Original

This is the version that does not parse for inline anki cards. Useful if you use :: for dataview fields

Flashcards

GitHub release (latest SemVer) GitHub All Releases

Anki integration for Obsidian.

Features

🗃️ Simple flashcards with #card
🎴 Reversed flashcards with #card-reverse
📅 Spaced-only cards with #card-spaced
✍️ Inline style with Question::Answer
✍️ Inline style reversed with Question:::Answer
🧠 Context-aware mode
🏷️ Global and local tags
🔢 Support for LaTeX
🖼️ Support for images
🎤 Support for audios
🔗 Support for Obsidian URI
⚓ Support for reference to note
📟 Support for code syntax highlight

How it works?

The following is a demo where the three main operations are shown:

  1. Insertion of cards;
  2. Update of cards;
  3. Deletion of cards.

Demo image

How to use it?

The wiki explains in detail how to use it.

How to install

  1. Install this plugin on Obsidian

    From Obsidian v0.9.8+, you can activate this plugin within Obsidian by doing the following:

    • Open Settings > Third-party plugin
    • Make sure Safe mode is off
    • Click Browse community plugins
    • Search for "Flashcards"
    • Click Install
    • Once installed, close the community plugins window and activate the newly installed plugin
  2. Install AnkiConnect on Anki

    • Tools > Add-ons -> Get Add-ons...
    • Paste the code 2055492159 > Ok
    • Select the plugin > Config > Paste the configuration below

Configuration:

{
    "apiKey": null,
    "apiLogPath": null,
    "webBindAddress": "127.0.0.1",
    "webBindPort": 8765,
    "webCorsOrigin": "http://localhost",
    "webCorsOriginList": [
        "http://localhost",
        "app://obsidian.md"
    ]
}