README.md

lists.nvim

The idea is to be able to display any sort of a list if you need a reminder. I use this to remind myself the purpose of conventional commits and some of the vim commands I tend to forget.

Originally I explored an easier way to display those lists with built-in messages, but this protocol doesn't allow to conveniently display multi-line strings. Thus I tried to implement the same idea as a plugin, which allowed me to use more pleasant UI and get some lua experience along the way.

Installation

Using packer:

use { 'Sc4ramouche/lists.nvim', requires = 'nvim-lua/plenary.nvim' }

Example usage

local vm_contents = {
    ":so %   – source current buffer",
    "C-w v   – vertical split",
    "zz      – center view",
    "{ and } – move up or down 1 paragaph",
    "va{     – find next block of braces",
}
vim.keymap.set('n', '<leader>lv', function()
    require('lists').toggle_menu({ title = "Vim Motions", contents = vm_contents })
end)

Acknowledgements

• Writing Neovim Plugins – A Beginner Guide, learned a great trick on how to setup and reload a plugin without quitting vim.
• The UI is inspired by Harpoon, relying on popup provided by plenary.