AnkiLink

I've switched to a Personal Knowledge Management Application(SiYuan Note) and made an Anki-sync tool for that.(AnkiSiyuan). As a consequence, this tool won't be actively developed. However, it has been mature to some extent so don't fear trying. Feel free to report an issue if you encounter a bug.

See AnkiLink Project for future plans.

Introduction

ATTENTION: This tool is for users, if you are a developer, please visit AnkiIn.

AnkiLink enables you to import Anki notes directly from your markdown files. It is simple, easy to use yet that powerful.

There are tons of Anki Importers in the world, while this one features minimalism.

Features:

• Directly Import into Anki
• Directly Export to apkg file without Anki
• Human-Friendly Syntax
• Markdown Rendering Support
• Html Support
• Cross-Platform
• Binary Build available
• Many Useful built-in Note Types:
  • Q&A
  • Cloze
  • Choices
  • ListCloze
  • TableCloze
• Easy to Extend

---

To use this tool, you are not required to sacrifice your note readability for compatibility with Anki.

Here is a quick example:

This is a question.
This is an answer.

Single line question.
Multiple line answer.
The first line of this block is recognized as the question.

Multiple line question is <br> possible somehow.
too hacky maybe.

markdown rendering is supported.
- use a list!
    - or something like that.

Clozes are **easy** to **create** too.

Installation

install Anki Connect

The first step is to install AnkiConnect extension. Code:2055492159
For detailed installation guide, please visit the anki-connect repo.

install Python

Install the latest version of Python.

This step is optional if you tend to use a binary release of the script.

download Script

Method 1: directly download the src folder.

Method 2: download binary release here, which doesn't require a python environment and is ready-to-use.

import ExampleDeck(abolished, please skip this step)

This step is necessary because several Note Types are included in the deck.

It will create an Export Deck in your Anki profile, plus a tag #Export.
By default, all cards imported by this tool would go into Export Deck with the tag Export, you can later modify them manually.

Also, it is configurable through command-line params, like ./AnkiLink test.md --tags tag1 tag2 --deck targetDeck

Download and import it into your Anki.

This is what the Deck is like:

Now, the installation is done.

Usage

This is a command-line tool.

On windows, open cmd and execute with:
{yourpath}\AnkiLink.exe {yourfile}
Alternatively, if you use the raw script, execute with: python -m {yourpath}\src {yourfile}

The process is similar on other platforms.

For more usage, enter .\AnkiLink -h or something like that to see.

Export to apkg file

If you want to export your notes to an apkg file, you can use -o filename param.

For example, generate an apkg file from test2.md:

python -m src tests/test2.md -o test.apkg

Note Structure

The note to import must follow some specific structure so that it can be recognized by the script.

A block is recognized as a note. To clarify what a block is, see the example:

It is notable that Html syntax is supported in notes.

This is a block.

This is a multiple-line  
block.

This is also a **block**.

Blocks are separated by two line breaks.

Note Type

Q&A

The most basic type in Anki.
Any block more than two lines, if not recognized as the other types, would be recognized as Q&A.

Question.
Answer.

Cloze

Another basic type in Anki.
Any block containing **sth.** in its first line would be recognized as a Cloze.

This is a **Cloze**.

This is another **Cloze**  
with more than one **line**.

This is not a Cloze.
But rather a **Q&A**.

Choices

Choose A or choose B...that's a question.

This is an extended note type that is not included in plain Anki.
I imported a modified version of Monokaicloze to implement this feature.

Any block starting with A in its second line would be recognized as a Choices.

Question:
A Option1
B Option2
C Option3
A
Remark writing, something here, can be omitted.

Question:
A Option1
B Option2
C Option3
AB

I just want a simple Q&A.
 A simple Q&A. Use space to avoid being recognized as Choices.

ListCloze

A list would be recognized as a cloze.

- List Cloze
  - Cloze **as** a list
  - no need to contain a cloze in the first line
      - pretty **handy**
      - but remember this may make a card huge!

Example List QA
- A list, or an outlined format, are now supported.
  - SHJKD
  - lksfdhos
  - sdhfksaj
      - dskf
      - sdkf    
      - dfjs
      - dfjs
      - oipw3
  - dppp

TableCloze

A table would be recognized as a cloze.

Table is now supported too.
| Syntax      | Description | Test Text     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |
A funny feature.

| Table      | Cloze | is also supported |
| :---        |    :----:   |          ---: |
| H**e**ader      | Title       | Here's this   |
| Parag**ra**ph   | Text        | And more      |

---

For more examples, see tests.

Alternatives

Tons of AnkiLinks out there. Here are some alternatives, some of which may suit your need.

• apy: need to install Anki source, directly write to Anki database without opening Anki or importing apkg into Anki. Linux-friendly.
• Anki-Import: similar syntax with my AnkiLink but too many linebreaks. Lack of markdown support. Haven't been updated for years.
• inka: yet another powerful tool.
• Obsidian_to_Anki: a mature solution, almost what I want.

Credit

• AnkiIn
• anki
• anki-connect
• genanki
• markdown2

License

The source code is licensed under GPL v3.
License is available here.