Skip to content

mamachanko/ankify

Repository files navigation

Ankify 📝 → 🗃

Create Anki decks from Markdown notes

Let's say you've been reading a book about command line tools and took these notes:

---
title: My Notes
---

# How to exit Vim

`:wq`, `:x` or `ZZ`

# Cool tools
 * xargs
 * awk

Ankify will create a deck called My Notes with two cards:

Front Back
How to exit Vim :wq, :x or ZZ
Cool tools
  • xargs
  • awk

You can import this deck into Anki.

Installation & usage

On the command-line

  • Read from stdin:

    $ cat notes.md | python ankify.py > notes.apkg
    
  • Provide a filename:

    $ python ankify.py notes.md
    

Using docker

$ cat notes.md | docker run -i mamachanko/ankify > notes.apkg

todos

  • fix markdown rendering
  • validate that reading from stdin amd writing to stdout works with docker run
  • investigate what the workflow of updating cards and re-importing a deck would look like
  • read from stdin
  • write to stdout
  • refactor to classes
  • build docker image
  • publish image
  • [] return stable guids for notes (see here)
  • [] set card number
  • [] automate docker image building and publishing
  • [] create ankify website
  • [] create web API
  • [] get domain
  • [] publish module to pypi
  • [] make module invokeable through 'python -m ankify'