Skip to content

kovs713/anki.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

28 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

anki.nvim

flashcards without leaving Neovim.

AnkiConnect bridge for reviewing Anki decks in a floating window.

features

area detail
review :AnkiReview deck picker or direct deck start
scheduler real Anki reviews through AnkiConnect
ui centered review float, plain-text card rendering
state last deck only

install

{
  "kovs713/anki.nvim",
  cmd = { "AnkiReview" },
  config = function()
    require("anki_review").setup()
  end,
}
vim.pack.add({
  "https://github.com/kovs713/anki.nvim",
})

requires Neovim 0.10+, curl, Anki, and AnkiConnect (2055492159).

Anki must be open for reviews. AnkiConnect must listen on http://127.0.0.1:8765.

config

require("anki_review").setup({
  anki = {
    endpoint = "http://127.0.0.1:8765",
    version = 6,
    timeout = 5000,
  },
  window = {
    width = 0.7,
    height = 0.7,
    min_width = 40,
    min_height = 12,
    border = "rounded",
  },
  picker = {
    width = 0.5,
    height = 0.6,
  },
  behavior = {
    remember_last_deck = true,
    default_ease = 3,
  },
})

commands

command action
:AnkiReview open deck picker
:AnkiReview <deck> review deck
:AnkiReview! review last deck
:AnkiReview deck <deck> force deck name

keys

key action
<Space> reveal answer
<CR> answer Good / next card
1 Again
2 Hard
3 Good
4 Easy
q quit

completion keys: r review same deck, q close.

state

Plugin state lives at:

stdpath("state")/anki_review/state.json

it stores plugin-owned state only: last deck.

why

yes, Anki still has to be open.

no, you do not have to look at it.

Anki handles the scheduler.

Neovim handles the cave.

you handle the queue.


terminal gremlin certified

About

Nvim lua plugin for reviewing anki decks ๐Ÿƒ

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages