flashcards.nvim

Flashcards neovim plugin
git clone git://git.laack.co/flashcards.nvim.git
Log | Files | Refs | README | LICENSE

README (1051B)

      1 flashcards.nvim - flashcards in your editor
      2 ===========================================
      3 
      4 Installation
      5 ============
      6 With packer:
      7 
      8     use {
      9         'git://git.laack.co/flashcards.nvim', 
     10         commit = "5979f57fc0650df0a280c5cbe1cdea968080bd64"
     11     }
     12 
     13 Keybindings
     14 ===========
     15 Put the following in your config file:
     16 
     17     -- default: N/A
     18     vim.api.nvim_set_keymap('n', '<leader>f', '<Cmd>Flash<CR>', {})
     19     -- default: right arrow, l
     20     -- vim.api.nvim_set_keymap('n', '<leader>fn', '<Cmd>NextCard<CR>', {})
     21     -- default: left arrow, h
     22     -- vim.api.nvim_set_keymap('n', '<leader>fp', '<Cmd>PreviousCard<CR>', {})
     23     -- default: up / down arrow, j / k
     24     -- vim.api.nvim_set_keymap('n', '<leader>ff', '<Cmd>Flip<CR>', {})
     25 
     26 
     27 Usage
     28 =====
     29 :Flash command expects the cwd to have some files with the .md file extension. In such a directory, this command will open a random flashcard.
     30 
     31 The first line of the file must be an H1 header where the associated text is the flashcard's title. The back of the flashcard will be all other lines of the file.