Home

Awesome

Obsidian_to_Anki

Plugin to add flashcards from a text or markdown file to Anki. Run in Obsidian as a plugin, or from the command-line as a python script. Built with Obsidian markdown syntax in mind. Supports user-defined custom syntax for flashcards.
See the Trello for planned features.

Getting started

Check out the Wiki! It has a ton of information, including setup instructions for new users. I will include a copy of the instructions here:

Setup

All users

  1. Start up Anki, and navigate to your desired profile.
  2. Ensure that you've installed AnkiConnect.

Obsidian plugin users

  1. Have Obsidian downloaded
  2. Search the 'Community plugins' list for this plugin
  3. Install the plugin.
  4. In Anki, navigate to Tools->Addons->AnkiConnect->Config, and change it to look like this:
<pre> { "apiKey": null, "apiLogPath": null, "webBindAddress": "127.0.0.1", "webBindPort": 8765, "webCorsOrigin": "http://localhost", "webCorsOriginList": [ "http://localhost", "app://obsidian.md" ] } </pre>
  1. Restart Anki to apply the above changes
  2. With Anki running in the background, load the plugin. This will generate the plugin settings.

You shouldn't need Anki running to load Obsidian in the future, though of course you will need it for using the plugin!

To run the plugin, look for an Anki icon on your ribbon (the place where buttons such as 'open Graph view' and 'open Quick Switcher' are). For more information on use, please check out the Wiki!

Python script users

  1. Install the latest version of Python.
  2. If you are a new user, download obstoanki_setup.py from the releases page, and place it in the folder you want the script installed (for example your notes folder).
  3. Run obstoanki_setup.py, for example by double-clicking it in a file explorer. This will download the latest version of the script and required dependencies automatically. Existing users should be able to run their existing obstoanki_setup.py to get the latest version of the script.
  4. Check the Permissions tab below to ensure the script is able to run.
  5. Run obsidian_to_anki.py, for example by double-clicking it in a file explorer. This will generate a config file, obsidian_to_anki_config.ini.

Permissions

The script needs to be able to:

Features

Current features (check out the wiki for more details):

Note that all custom syntax is off by default, and must be programmed into the script via the config file - see the Wiki for more details.

<a href='https://ko-fi.com/K3K52X4L6' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>