A Lua plugin for Neovim that helps you organize and search helpful tips, tricks, and shortcuts via a fuzzy search interface.
I started to work on this little plugin because I love neovim and I still remember how difficult it was to learn the basic commands. I was like that Twitter guy who said:
"I've been using Vim for about 2 years now, mostly because I can't figure out how to exit it."
The plugin should help you to learn some basic (:wq, write and quit) and some not so basic commands (ddp, move line down) related to neovim.
I have provided a solid initial batch of tips and if you have your favorite one that is not listed, I will be happy to include it in the next release with proper credits. Send your commands, tips and tricks to me, create an issue or submit a pull request. You can also add your own tips and tricks that will be stored on your local computer, you don't have to share anything with me.
- Search tips using ultra-fast
fzf-luaplugin - Preview rendered descriptions in markdown format
- No additional utilities: you don't need
gloworbatto render the tip - Support for categories, tags, and rich text
- The plugin comes with a starting set of basic, predefined tips
- You can add/edit unlimited number of personal tips stored in a configurable file
{
"saxon1964/neovim-tips",
dependencies = { "ibhagwan/fzf-lua" },
opts = {
-- OPTIONAL: Location of user defined tips (default value shown below)
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
},
init = function()
-- OPTIONAL: Change to your liking or drop completely
-- The plugin does not provide default key mappings, only commands
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })
end
}use {
"saxon1964/neovim-tips",
requires = { "ibhagwan/fzf-lua" },
config = function()
require("neovim_tips").setup {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
}
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })
end
}Plug 'ibhagwan/fzf-lua'
Plug 'saxon1964/neovim-tips'
lua << EOF
require("neovim_tips").setup {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
}
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })
EOFcall minpac#init()
call minpac#add('ibhagwan/fzf-lua')
call minpac#add('saxon1964/neovim-tips')
lua << EOF
require("neovim_tips").setup {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
}
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })
EOFrequire "paq" {
"ibhagwan/fzf-lua";
"saxon1964/neovim-tips";
}
require("neovim_tips").setup {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
}
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })call dein#begin('~/.cache/dein')
call dein#add('ibhagwan/fzf-lua')
call dein#add('saxon1964/neovim-tips')
call dein#end()
lua << EOF
require("neovim_tips").setup {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
}
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })
EOF
require("lazy").setup({
{
"saxon1964/neovim-tips",
dependencies = { "ibhagwan/fzf-lua" },
opts = {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
},
init = function()
local map = vim.keymap.set
map("n", "<leader>nto", ":NeovimTips<CR>", { desc = "Neovim tips", noremap = true, silent = true })
map("n", "<leader>nte", ":NeovimTipsEdit<CR>", { desc = "Edit your Neovim tips", noremap = true, silent = true })
map("n", "<leader>nta", ":NeovimTipsAdd<CR>", { desc = "Add your Neovim tip", noremap = true, silent = true })
end,
},
})File lua/user/plugins/neovim_tips.lua:
return {
{
"saxon1964/neovim-tips",
dependencies = { "ibhagwan/fzf-lua" },
opts = {
user_file = vim.fn.stdpath("config") .. "/neovim_tips/user_tips.txt",
},
},
}File lua/user/mappings.lua
return {
n = {
["<leader>nto"] = { "<cmd>NeovimTips<cr>", desc = "Neovim tips" },
["<leader>nte"] = { "<cmd>NeovimTipsEdit<cr>", desc = "Edit your Neovim tips" },
["<leader>nta"] = { "<cmd>NeovimTipsAdd<cr>", desc = "Add your Neovim tip" },
},
}:NeovimTips— Open searchable list of tips:NeovimTipsEdit— Edit your personal tips file:NeovimTipsAdd— Insert a new tip template into your personal file and start editing
Each tip should follow this format in your tips file:
# Title: My tip title
# Category: My category name
# Tags: tag1, tag2, tag3
---
This is a description of what the tip does.
```vim
normal-mode-command
```
===Description of the tip starts with --- and ends with ===. There is NO predefined format for description. Anything between the starting and ending marker will be interpreted as a text in markdown (.md) format. Fzf-lua will render the markdown description in the right FZF panel.
# Title: Delete word under the cursor
# Category: Edit
# Tags: delete, word, cursor
---
In normal mode use `:diw` to delete the word under the cursor.
```vim
:diw
```
===- Built-in tips:
<plugin_directory>/data/ - User tips:
~/.config/nvim/neovim_tips/user_tips.md
- Category filtering
- Search descriptions
- Support for other popular pickers (telescope, snacks, mini...)
- Lazy loading
- Multiple tip sources
- Unlicense. You can find more details in the license file or here