flashcards.nvim

A Neovim Lua plugin for creating and studying flashcards.

NOTE: If you were using this plugin before the most recent commit then unfortunately your flashcards will no longer work because of the restructuring of how flashcards are stored. I apologize.

Installing

You can install this plugin using packer.nvim:

require('packer').startup(function(use)
    use { 'alex-laycalvert/flashcards.nvim' }
end)

After installing the plugin, add this to your init.lua file:

require('flashcards').setup({
    -- ... your configurations
})

Configuration

• dir: Directory where flashcards are stored (default: $HOME/.config/flashcards)
• flashcards = { ... }: Config for flashcards
  • show_terms: Boolean value for whether flashcards should show terms first (default: true)
• subjects = { ... }: Config for the subjects menu (TODO)

Subjects

Subjects are collections of flashcards and are stored as directories of json files representing your flashcards in your flashcards dir. When openening Flashcards, a browse subjects menu will open allowing you to create, open, edit, and delete your subjects.

Default Mappings:

• j, k: Moving up and down respectively.
• a: Create a new subject. Window opens for you to type the name.
• e: Edit the name of a subject. Window opens to change the name.
• d: Delete the selected subject, no confirm window pops up. Does not delete directory.
• r: Resets all progress of subject.
• q: Close window.
• enter: Open the selected subject.

NOTE: If you open the subjects browse menu while your flashcards are open and you delete the subject you are currently on, you will need to quit and reopen flashcards to avoid a file not found error.

Flashcards

Flashcards can be viewed by opening a subject and can be created, edited, flipped, and deleted. You can toggle whether you know cards or not and they will be reflected on the progress for the subject.

Default Mappings:

• n, l: Goto next flashcard.
• b, h: Goto previous flashcard.
• f, enter, space: Flip flashcard.
• k: Toggle whether you know the card or not.
• a: Add a new flashcard. A window will popup for you to enter the term, then another to enter the definition.
• e: Edit current side of flashcard.
• d: Delete the current flashcard.
• o: Browse all subjects.