From 3e83061a21f651dad180d4aac47c2a2acb3aea9d Mon Sep 17 00:00:00 2001 From: louie Date: Sun, 7 Jan 2018 17:24:57 +0800 Subject: [PATCH] Update README --- README.org | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/README.org b/README.org index 29a14d1..7497d18 100644 --- a/README.org +++ b/README.org @@ -1,23 +1,30 @@ anki-editor -- an Emacs package that helps you create Anki cards in Org-mode * Requirements -- [[https://github.com/FooSoft/anki-connect#installation][anki-connect]], - an Anki add-on which is required for this package to interact with - Anki. -- curl + - [[https://github.com/FooSoft/anki-connect#installation][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][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 field names - - The content of a field heading is the text of this field -4. Have a look at the commands listed below, they might be helpful on note creation/editing - - =anki-editor-submit= :: Send notes in current buffer to Anki - - =anki-editor-setup-default-keybindings= :: Setup default keybindings (all keys are prefixed with =C-c a=) + 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][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 fragment translated to + the Anki syntax + 4. Command Cheat Sheet + | Command | Default 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 a note heading that's one level lower to current heading. The inserted heading will be structured with the property drawer and subheadings that correspond to the fields of the selected note type. | + | =anki-editor-export-heading-contents-to-html= | C-c a e | Export the contents of the heading at point to HTML. | ** Demo -[[./demo.gif]] + [[./demo.gif]]