Skip to content

bennyyip/flashcards-obsidian

 
 

Repository files navigation

⚠️ I am currently looking out for a co-maintainer. Look at #125, and if you are interested let me know :)


Flashcards

GitHub release (latest SemVer) GitHub All Releases

logo Anki integration for Obsidian.

Features

🗃️ Simple flashcards with #card
🎴 Reversed flashcards with #card-reverse or #card/reverse
📅 Spaced-only cards with #card-spaced or #card/spaced
✍️ Inline style with Question::Answer
✍️ Inline style reversed with Question:::Answer
📃 Cloze with ==Highlight== or {Curly brackets} or {2:Cloze}
🧠 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

For other features check the wiki.

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:

    • Open Settings > Community plugins
    • 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
  3. Open the settings of the plugin, and while Anki is opened press "Grant Permission"

Contributing

Contributions via bug reports, bug fixes, are welcome. If you have ideas about features to be implemented, please open an issue so we can discuss the best way to implement it. For more details check Contributing.md

Support

If flashcards plugin is useful to you and you want to support me, you can thank me with a coffee :) ko-fi

About

🎴 An Anki plugin for Obsidian.md

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.8%
  • JavaScript 0.2%