anki-editor/README.org

• Requirements
• Usage
  • Demo

anki-editor – an Emacs package that helps you create Anki cards in Org-mode

Requirements

• anki-connect, an Anki add-on which is required for this package to interact with Anki.
• curl

Usage

1. Download it and put it into your Emacs' load-path
2. (require 'anki-editor)

3. Write notes in org syntax, e.g. examples.org

   • Headings of deck are tagged with deck
   • Headings of note are tagged with note
   • Custom properties of a note heading can be used to specify note type and tags
   • Subheadings of a note heading are fields of its note type
   • The contents of field headings will be converted to html by org-mode's html backend, with the latex syntax translated to the Anki style

4. Command Cheat Sheet

   Command	Keybinding	Description
   anki-editor-setup-default-keybindings	N/A	Set up default keybindings.
   anki-editor-submit	C-c a s	Send notes in current buffer to Anki.
   anki-editor-insert-deck	C-c a i d	Insert a deck heading with the same level as current heading. With prefix, only insert the deck name.
   anki-editor-insert-note	C-c a i n	Insert the skeleton of a note, which is structured with a note heading one level lower to the current one as well as subheadings that correspond to fields.
   anki-editor-export-heading-contents-to-html	C-c a e	Export the contents of the heading at point to HTML.
   anki-editor-convert-region-to-html	N/A	Convert and replace region to HTML.
   anki-editor-anki-connect-upgrade	N/A	Upgrade anki-connect to the latest version. This will display a confirmation dialog box in Anki asking if you want to continue.

Not a native speaker, hope this README is clear enough. Happy hacking :)

Demo