Skip to content

MFreidank/AnkiVim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AnkiVim

Build Status Health Coverage Pypi

Overview

Use vim to rapidly write textfiles immediately importable into anki(1).

Requirements

  • Python >= 2.7 or Python >= 3.4

Installation

Simply run:

pip install AnkiVim

You can verify that this step succeeded and see available options by running:

anki-vim -h

Generating Anki Cards

  1. Call:
anki-vim DECKNAME
  1. vim starts with a preformatted card. Start typing the front part of the anki card below "QUESTION", then fill out the back below "ANSWER". (NOTE: It is important to leave the QUESTION and ANSWER headers intact throughout)
  2. save the file and exit the editor. (vim: ":wq") => the card contents are saved to: $HOME/.ankivim/decks/DECKNAME/raw_cards.txt. (alternatively, you can specify a custom location for your decks using the --deckpath option of script/anki-vim.py.)
  3. editor starts right back up to generate a new card for the same deck => Iterate 2.-4. until all cards are generated.
  4. to stop the card creation process, simply close your editor ( for vim: ":q" or ":q!", for additional information see this book)

Importing into Anki

Procedure to import anki cards generated by this tool into anki:

  1. Open Anki
  2. Generate the deck to import into or click on an existing deck
  3. Click import and navigate to "/path/to/anki-vim/decks/DECKNAME/raw_cards.txt"
  4. check "allow html in fields"
  5. Done

Supports:

  • Latex commands of any kind
  • html tags of any kind (images can be included this way as well)
  • uses snippets : allows for quick insertion of latex and cloze, for example cc<TAB> will add {{c1::cloze}}. For more information, click here.

About

Use vim (or your favorite editor) to write anki cards quickly in plain text or latex.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published