Metadata-Version: 2.0
Name: ankdown
Version: 0.1.1
Summary: A utility for converting Markdown into Anki cards
Home-page: https://github.com/benwr/ankdown
Author: Ben Weinstein-Raun
Author-email: b@w-r.me
License: MIT
Keywords: anki spaced-repetition markdown math latex
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: docopt (>=0.6.2)
Requires-Dist: genanki (>=0.4.0)
Requires-Dist: misaka (>=2.1.0)

# Ankdown

A simple way to write Anki decks in Markdown.

## What This Is

[Anki](https://apps.ankiweb.net) is awesome, in many ways.
However, its card editor is... a little bit uncomfortable.
I really wanted to write Anki cards in Markdown. So I made
a tool to convert Markdown (+ standard MathJAX math notation)
into Anki decks that can be easily imported. This way, it's
possible to use any fancy markdown (and MathJAX) tools to build
your decks.

## How to use it

**NOTE** This program requires _Python 3_, along with the
packages in requirements.txt

Write a card in the following format:

```markdown
Expected Value of $f(x)$

%

$$\mathbb{E}[f(x)] = \sum_x p(x)f(x)$$

%

math, probability

%%
```

Each of the solitary `%` signs is a field separator: the first
field is the front of the card by default, the second field is
the back of the card, and subsequent fields can contain whatever
you want them to (all fields after the second are optional).

Each of the double `%%` signs represent a card boundary.

The tool only needs the `%` signs to be alone on their own lines,
but most markdown editors will work better if you separate them from
other text with empty lines, so that they're treated as their own
paragraphs.

To compile the cards, put them in a file (e.g. `notes.md`), and run
them through `python ankdown.py -p notes.apkg -d Notes -i notes.md`.

To add them to Anki, go to File > Import, and select the file you created
(e.g. `notes.apkg`).

**IMPORTANT**: When using the text format rather than the .apkg,
make sure that the separator is set to `\t`, you've selected the deck
you want to modify, and that "Allow HTML" is checked.

Press "Import", and you should be good to go.

