NOTE: Since the creation of this plugin I found that it not only overlaps with which-key, but also with :FzfLua keymaps. I will probably not work further on the plugin.

An experimental Lua plugin for Neovim showing cheat sheets. The repository is mostly intended for me to learn about neovim and lua, but if you find it useful, feel free to use it!

The original name was cheetah, but then I found that there is already a plugin with that name. The current name chitshit is pronounced like "cheat sheet".

• Keymaps cheat sheet. But for dynamic help you may prefer using which-key.nvim.
  • It also shows at the end the available <Leader> combinations that you can use.
  • And it also shows you at the beginning your current <Leader> key

{
  "jpc-hpe/chitshit.nvim",
  opts = {},
}

use {
  'jpc-hpe/chitshit.nvim',
  config = function()
    require('chitshit').setup{}
  end
}

Plug 'jpc-hpe/chitshit.nvim'

After installation, include in your configuration:

require('chitshit').setup{}

With lazy.nvim, you do not need this explicitly, as it already happens if you have opts in the spec

You can configure the plugin by passing options to the setup function:

require('chitshit').setup({
  enabled = true,
  -- Add more configuration options as needed
})

• :ChitshitKeymaps - Create buffer with keymaps cheatsheet

No keymap is provided by default. I am personally planning to use <Leader><Leader>c+whatever as no other plugin is using the "double leader" combination. The following is what I have in my ~/.nvim/lua/config/keymaps.lua (yes, I use LazyVim):

vim.keymap.set(
  'n',
  '<Leader><Leader>ck',
  ':ChitshitKeymaps<CR>',
  {
    noremap = true,
    silent = true,
    desc = "Chitshit: Show keymaps cheatsheet"
  }
)

• require('chitshit').setup(opts) - Initialize the plugin with options
• require('chitshit.commands.keymaps').keymaps_cheatsheet() - Create buffer with keymaps cheatsheet

MIT License, see LICENSE for details.