Skip to content

Clouder0/AnkiIn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AnkiIn

Release MIT License Issues Stargazers Forks Contributors CodeFactor

See AnkiLink Project for future plans.

Introduction

AnkiIn is a Python Package that enables you to generate Anki cards from markdown text.
It is easy to use and powerful.

ATTENTION! This repo is for developers, so if you just want to use an Anki Importer, please check AnkiLink

Features:

  • Directly Import into Anki via anki-connect
  • Directly Export to apkg file with Anki offline via genanki
  • Inline Configuration
  • Human-Friendly Syntax
  • Markdown Rendering Support
  • Html Support
  • Cross-Platform
  • Many Useful built-in Note Types:
    • Q&A
    • Cloze
    • Choices
    • ListCloze
    • TableCloze
  • Easy to Extend

To use this lib, 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

You can install by pip:

pip install AnkiIn

install Anki Connect

To use the lib, you need to install AnkiConnect extension.
Code:2055492159
For detailed installation guide, please visit the anki-connect repo.

Usage

You can review AnkiLink to understand how this works.

Also, AnkiIn Wiki is under construction.

For more syntax examples, see tests.

Applications

I'd like to list some applications using AnkiIn here.
If you want to add yours, please create an issue/pull request.

Credit

License

The source code is licensed under MIT. License is available here.