README.md

inka

⚠️ I have stopped maintaining Inka for personal reasons. But there is a fork that is actively developed: inka2. I recommend you to take a look at it.

Automatically add your Markdown flashcards to Anki.

• Installation
  • Requirements
• Why
• Features
• Usage
  • Creating Cards
  • Adding Cards to Anki

Installation

Install inka:

python3 -m pip install inka --upgrade

Requirements

• Anki >= 2.1.54
• Python >= 3.10

Why

I've been using Anki for a long time, and at some point my notes turned into just lists of question/answer pairs, from which I then created Anki cards. The process of creating flashcards in Anki took a long time, so I decided to write a Python script to automate it. With more and more features added, the script has evolved into the command-line tool you can see now.

inka allows you to use full power of Markdown when creating flashcards. The program is also extensively tested.

Features

• Cards are automatically added to your Anki deck
• Basic and Cloze note types support
• Synchronization of changes with Anki
• Configuration via config file
• Images support
• MathJax support
• Code highlight
• Hashing (for better performance)

Usage

Creating Cards

In order for the program to be able to separate cards from all the rest of the text in the file, you need to enclose them between two ---:

---

Deck: Life Questions

Tags: learning life-questions

1. What is the answer to the Ultimate Question of Life, the Universe, and Everything?

> 42

2. If it {{c1::looks like a duck, swims like a duck, and quacks like a duck}}, then it is a {{c2::duck}}.

---

You can create any number of such sections in the file.

⚠️ This means that you should avoid using the --- syntax anywhere else in the file for inka to work correctly. There are exceptions, and you can read about them in documentation.

Inside the section, you can specify the name of the deck to which the cards will be added, and tags for the cards. If deck name isn't specified, then the one from the config is used (Default by default). The deck name is written after Deck:, and tags for all cards after Tags: with spaces between each tag.

Two types of notes are supported:

• Front/Back: every question starts with number followed by period (e.g. 1., 2. - Markdown ordered list syntax) and every line of the answer starts with > (Markdown quote syntax). Question and answer can span multiple lines.
• Cloze: same as Front/Back notes, Cloze notes start with number followed by period (Markdown ordered list syntax). inka supports three versions of syntax for cloze deletions:
  • Anki syntax: {{c1::hidden text}}
  • Short explicit syntax: {1::hidden text} or {c1::hidden text}
  • Short implicit syntax: {hidden text}

More info and examples on the creating cards documentation page.

Adding Cards to Anki

inka will create custom note types for Front/Back and Cloze notes. If you want to use different ones, you can change note types in the config.

Add cards from the file:

inka collect path/to/cards.md

Or from all Markdown files in a directory:

inka collect path/to/directory

You can also pass multiple paths at once:

inka collect path/to/cards.md path/to/folder

You can find more information on the documentation page.