anki-rb's Introduction

ankirb

A basic gem to create Anki decks (.apkg). Supports integrated media (audio, images and videos).

Installation

Add this line to your application's Gemfile:

gem 'ankirb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ankirb

Usage

require 'ankirb'

#create a deck
deck = Anki::Deck.new 'FancyExampleDeck'

#create a basic card
card = Anki::Card.new(:front=>"What is the french for cheese omelette?", :back=>"Omelette au fromage")

#add audio to the back
card.back << "dexters_lab_omelette.wav"

#add card to the deck
deck.add_card card

#add the reverse version of the card
deck.add_card card.invert 

#export to ~/Anki/Decks/FancyExampleDeck.apkg
Anki::apkg.export deck, "~/Anki/Decks"

Media types

Media can be added to a card face via the << operator, just pass a string that points to a valid media file and the lib will convert + package the file.

For images, the position of the image in the card can be set by using a placeholder {{img}}.

card = Anki::Card.new :front => "{{img}} text after image", :back => "text before image {{img}}"
card.front << "front_img.jpg"
card.back << "back_img.jpg"

If no placeholder is present the image will just be added at the end. If multiple placeholders are present, they'll be replaced sequentially with the image files added to the card.

As with anki, html tags can be used for more styling in the card content. Card model / css template support may be added in future.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rkachowski/ankirb.

License

The gem is available as open source under the terms of the MIT License.

anki-rb's People

Contributors

Stargazers

Watchers

anki-rb's Issues

fix require issue

can't correctly run require 'ankirb', which is a little bit of a downer

Encoding errors

Anki droid shows some garbage when using non ascii chars. Likely there is a way to enforce utf8 encoding somewhere in the schema. i need to look into this

document how to create tags / support tags

It would be wonderful if it would be possible to create tags (like those mentioned here / supported in the anki gem)

document how to create subdecks / support subdecks

It would be wonderful if it would be possible to create subdecks (like those mentioned here)

looking for ways to automate anki-deck creation

I am very interested to learn about ways to to automize the creation of anki-decks and just starting to learn about the subject.

I haven't tested your project yet, but it seems to be an extension of https://github.com/dennmart/anki? Do you happen to know other projects, which also try to create anki-decks from some source document?

It is my goal to maintain some deck-source-files on github e.g. and find a elegant way to create anki-decks from them. The plainer and readable the source-file the better and the incorporation of markdown in the source and html or pdf in the flashcards themselves would be ideal (though this may not be supported). I would like to incorporate syntax-highlighted code-snippets this way and control their appearance (possible alternative: https://ankiweb.net/shared/info/1463041493).

I will also post in the Anki-forums, but any shared thoughts would be greatly appreciated.

Kind regards! :)

Recommend Projects

rkachowski / anki-rb Goto Github PK