Skip to main content

Import markdown to Anki

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AnkiIn-0.1.7.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

AnkiIn-0.1.7-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file AnkiIn-0.1.7.tar.gz.

File metadata

  • Download URL: AnkiIn-0.1.7.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for AnkiIn-0.1.7.tar.gz
Algorithm Hash digest
SHA256 13c75e0b4f033b3c203ef8a2700f9f2dd613cd37ce1d93faecf5a7b32a284865
MD5 6227c6f52c578999ce430c37752e8728
BLAKE2b-256 7edab7dfef2ea7ef449b321d176615d08e1e671783c7865aec1539a63c7d8d80

See more details on using hashes here.

File details

Details for the file AnkiIn-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: AnkiIn-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 18.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for AnkiIn-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 3c69dde89afb81e11199bf20ee5ac8b37b3add43da6e21d69d78da5e1fbd92cf
MD5 04e0a119c9454260e813583866bea47b
BLAKE2b-256 1e6c56e9693a3042c58b57c7c1f2de181c952ecb69ad989c4eea2f10e9d8cad1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page