Git Product home page Git Product logo

anki-editor's Introduction

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
    CommandDefault KeybindingDescription
    anki-editor-setup-default-keybindingsN/ASet up default keybindings.
    anki-editor-submitC-c a sSend notes in current buffer to Anki.
    anki-editor-insert-deckC-c a i dInsert a deck heading with the same level as current heading. With prefix, only insert the deck name.
    anki-editor-insert-noteC-c a i nInsert 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-htmlC-c a eExport the contents of the heading at point to HTML.
    anki-editor-convert-region-to-htmlN/AConvert and replace region to HTML.

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

Demo

./demo.gif

anki-editor's People

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.