hiifong/LazyVim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(build): auto-generate vimdoc

Browse Source
This commit is contained in:
github-actions[bot]
2023-01-16 21:05:17 +00:00
parent aa47cc862b
commit 89c5d587f7
1 changed files with 167 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

266
doc/LazyVim.txt
View File

@ -411,6 +411,58 @@ Example spec: <code>lua/plugins/example.lua</code>
},
},
},
-- Use <tab> for completion and snippets (supertab)
-- first: disable default <tab> and <s-tab> behavior in LuaSnip
{
"L3MON4D3/LuaSnip",
keys = function()
return {}
end,
},
-- then: setup supertab in cmp
{
"hrsh7th/nvim-cmp",
dependencies = {
"hrsh7th/cmp-emoji",
},
---@param opts cmp.ConfigSchema
opts = function(_, opts)
local has_words_before = function()
unpack = unpack or table.unpack
local line, col = unpack(vim.api.nvim_win_get_cursor(0))
return col ~= 0 and vim.api.nvim_buf_get_lines(0, line - 1, line, true)[1]:sub(col, col):match("%s") == nil
end
local luasnip = require("luasnip")
local cmp = require("cmp")
opts.mapping = vim.tbl_extend("force", opts.mapping, {
["<Tab>"] = cmp.mapping(function(fallback)
if cmp.visible() then
cmp.select_next_item()
-- You could replace the expand_or_jumpable() calls with expand_or_locally_jumpable()
-- they way you will only jump inside the snippet region
elseif luasnip.expand_or_jumpable() then
luasnip.expand_or_jump()
elseif has_words_before() then
cmp.complete()
else
fallback()
end
end, { "i", "s" }),
["<S-Tab>"] = cmp.mapping(function(fallback)
if cmp.visible() then
cmp.select_prev_item()
elseif luasnip.jumpable(-1) then
luasnip.jump(-1)
else
fallback()
end
end, { "i", "s" }),
})
end,
},
}
<
@ -428,51 +480,53 @@ see a popup with all possible keymaps starting with `<space>`.
General
│ Key │ Description │ Mode │
│<C-h> │Go to left window │**n** │
│<C-j> │Go to lower window │**n** │
│<C-k> │Go to upper window │**n** │
│<C-l> │Go to right window │**n** │
│<C-Up> │Increase window height │**n** │
│<C-Down> │Decrease window height │**n** │
│<C-Left> │Decrease window width │**n** │
│<C-Right> │Increase window width │**n** │
│<A-j> │Move down │**n**, **v**, **i** │
│<A-k> │Move up │**n**, **v**, **i** │
│<leader>bb │Switch to Other Buffer │**n** │
│<leader> │Switch to Other Buffer │**n** │
│<esc> │Escape and clear hlsearch │**i**, **n** │
│<leader>ur │Redraw and clear hlsearch │**n** │
│n │Next search result │**n**, **x**, **o** │
│N │Prev search result │**n**, **x**, **o** │
│<C-s> │Save file │**i**, **v**, **n**, **s**│
│<leader>l │Lazy │**n** │
│<leader>fn │New File │**n** │
│<leader>xl │Open Location List │**n** │
│<leader>xq │Open Quickfix List │**n** │
│<leader>uf │Toggle format on Save │**n** │
│<leader>us │Toggle Spelling │**n** │
│<leader>uw │Toggle Word Wrap │**n** │
│<leader>ul │Toggle Line Numbers │**n** │
│<leader>ud │Toggle Diagnostics │**n** │
│<leader>uc │Toggle Conceal │**n** │
│<leader>gg │Lazygit (cwd) │**n** │
│<leader>gG │Lazygit (root dir) │**n** │
│<leader>qq │Quit all │**n** │
│<leader>sH │Highlight Groups at cursor│**n** │
│<leader>ft │Terminal (root dir) │**n** │
│<leader>fT │Terminal (cwd) │**n** │
│<esc><esc> │Enter Normal Mode │**t** │
│<leader>ww │other-window │**n** │
│<leader>wd │delete-window │**n** │
│<leader>w- │split-window-below │**n** │
│<leader>w\| │split-window-right │**n** │
│<leader><tab>l │Last │**n** │
│<leader><tab>f │First │**n** │
│<leader><tab><tab> │New Tab │**n** │
│<leader><tab>] │Next │**n** │
│<leader><tab>d │Close │**n** │
│<leader><tab>[ │Previous │**n** │
│ Key │ Description │ Mode │
│<C-h> │Go to left window │**n** │
│<C-j> │Go to lower window │**n** │
│<C-k> │Go to upper window │**n** │
│<C-l> │Go to right window │**n** │
│<C-Up> │Increase window height │**n** │
│<C-Down> │Decrease window height │**n** │
│<C-Left> │Decrease window width │**n** │
│<C-Right> │Increase window width │**n** │
│<A-j> │Move down │**n**, **v**, **i** │
│<A-k> │Move up │**n**, **v**, **i** │
│<leader>bb │Switch to Other Buffer │**n** │
│<leader> │Switch to Other Buffer │**n** │
│<esc> │Escape and clear hlsearch │**i**, **n** │
│<leader>ur │Redraw / clear hlsearch / diff update│**n** │
│n │Next search result │**n**, **x**, **o** │
│N │Prev search result │**n**, **x**, **o** │
│<C-s> │Save file │**i**, **v**, **n**, **s**│
│<leader>l │Lazy │**n** │
│<leader>fn │New File │**n** │
│<leader>xl │Open Location List │**n** │
│<leader>xq │Open Quickfix List │**n** │
│<leader>uf │Toggle format on Save │**n** │
│<leader>us │Toggle Spelling │**n** │
│<leader>uw │Toggle Word Wrap │**n** │
│<leader>ul │Toggle Line Numbers │**n** │
│<leader>ud │Toggle Diagnostics │**n** │
│<leader>uc │Toggle Conceal │**n** │
│<leader>gg │Lazygit (cwd) │**n** │
│<leader>gG │Lazygit (root dir) │**n** │
│<leader>qq │Quit all │**n** │
│<leader>sH │Highlight Groups at cursor │**n** │
│<leader>ft │Terminal (root dir) │**n** │
│<leader>fT │Terminal (cwd) │**n** │
│<esc><esc> │Enter Normal Mode │**t** │
│<leader>ww │Other window │**n** │
│<leader>wd │Delete window │**n** │
│<leader>w- │Split window below │**n** │
│<leader>w\| │Split window right │**n** │
│<leader>- │Split window below │**n** │
│<leader>\| │Split window right │**n** │
│<leader><tab>l │Last │**n** │
│<leader><tab>f │First │**n** │
│<leader><tab><tab> │New Tab │**n** │
│<leader><tab>] │Next │**n** │
│<leader><tab>d │Close │**n** │
│<leader><tab>[ │Previous │**n** │
LSP
@ -488,8 +542,9 @@ LSP
│gt │Goto Type Definition │**n** │
│K │Hover │**n** │
│gK │Signature Help │**n** │
│[d │Next Diagnostic │**n** │
│]d │Prev Diagnostic │**n** │
│<c-k> │Signature Help │**i** │
│]d │Next Diagnostic │**n** │
│[d │Prev Diagnostic │**n** │
│]e │Next Error │**n** │
│[e │Prev Error │**n** │
│]w │Next Warning │**n** │
@ -502,58 +557,70 @@ LSP
Plugins
│ Key │ Description │Mode │
│<leader>cm │mason.nvim <https://github.com/williamboman/mason.nvim.git> Mason │**n**│
│<leader>bd │mini.bufremove <https://github.com/echasnovski/mini.bufremove.git> Delete Buffer │**n**│
│<leader>bD │mini.bufremove <https://github.com/echasnovski/mini.bufremove.git> Delete Buffer (Force) │**n**│
│<leader>fe │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (root dir)│**n**│
│<leader>fE │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (cwd) │**n**│
│<leader>e │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (root dir)│**n**│
│<leader>E │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (cwd) │**n**│
│<S-Enter> │noice.nvim <https://github.com/folke/noice.nvim.git> Redirect Cmdline │**c**│
│<leader>snl │noice.nvim <https://github.com/folke/noice.nvim.git> Noice Last Message │**n**│
│<leader>snh │noice.nvim <https://github.com/folke/noice.nvim.git> Noice History │**n**│
│<leader>sna │noice.nvim <https://github.com/folke/noice.nvim.git> Noice All │**n**│
│<c-f> │noice.nvim <https://github.com/folke/noice.nvim.git> Scroll forward │**n**│
│<c-b> │noice.nvim <https://github.com/folke/noice.nvim.git> Scroll backward │**n**│
│<leader>un │nvim-notify <https://github.com/rcarriga/nvim-notify.git> Delete all Notifications │**n**│
│<leader>sr │nvim-spectre <https://github.com/windwp/nvim-spectre.git> Replace in files (Spectre) │**n**│
│<leader>qs │persistence.nvim <https://github.com/folke/persistence.nvim.git> Restore Session │**n**│
│<leader>ql │persistence.nvim <https://github.com/folke/persistence.nvim.git> Restore Last Session │**n**│
│<leader>qd │persistence.nvim <https://github.com/folke/persistence.nvim.git> Don’t Save Current Session │**n**│
│<leader>, │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Switch Buffer │**n**│
│<leader>/ │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find in Files (Grep) │**n**│
│<leader>: │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Command History │**n**│
│<leader><space> │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find Files (root dir) │**n**│
│<leader>fF │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find Files (cwd) │**n**│
│<leader>fb │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Buffers │**n**│
│<leader>ff │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find Files (root dir) │**n**│
│<leader>fr │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Recent │**n**│
│<leader>gc │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> commits │**n**│
│<leader>gs │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> status │**n**│
│<leader>sa │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Auto Commands │**n**│
│<leader>sC │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Commands │**n**│
│<leader>so │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Options │**n**│
│<leader>st │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Telescope │**n**│
│<leader>sh │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Search Highlight Groups │**n**│
│<leader>sG │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Grep (cwd) │**n**│
│<leader>sk │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Key Maps │**n**│
│<leader>sM │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Man Pages │**n**│
│<leader>sb │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Buffer │**n**│
│<leader>sc │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Command History │**n**│
│<leader>sg │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Grep (root dir) │**n**│
│<leader>sh │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Help Pages │**n**│
│<leader>sm │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Jump to Mark │**n**│
│<leader>ss │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Goto Symbol │**n**│
│]t │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Next todo comment │**n**│
│[t │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Previous todo comment │**n**│
│<leader>xt │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Todo Trouble │**n**│
│<leader>xtt │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Todo Trouble │**n**│
│<leader>xT │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Todo Telescope │**n**│
│<leader>xx │trouble.nvim <https://github.com/folke/trouble.nvim.git> Document Diagnostics (Trouble) │**n**│
│<leader>xX │trouble.nvim <https://github.com/folke/trouble.nvim.git> Workspace Diagnostics (Trouble) │**n**│
│]] │vim-illuminate <https://github.com/RRethy/vim-illuminate.git> Next Reference │**n**│
│[[ │vim-illuminate <https://github.com/RRethy/vim-illuminate.git> Prev Reference │**n**│
│ Key │ Description │ Mode │
│<leader>cm │mason.nvim <https://github.com/williamboman/mason.nvim.git> Mason │**n** │
│<leader>bd │mini.bufremove <https://github.com/echasnovski/mini.bufremove.git> Delete Buffer │**n** │
│<leader>bD │mini.bufremove <https://github.com/echasnovski/mini.bufremove.git> Delete Buffer (Force) │**n** │
│gza │mini.surround <https://github.com/echasnovski/mini.surround.git> Add surrounding │**n**, **v**│
│gzd │mini.surround <https://github.com/echasnovski/mini.surround.git> Delete surrounding │**n** │
│gzf │mini.surround <https://github.com/echasnovski/mini.surround.git> Find right surrounding │**n** │
│gzF │mini.surround <https://github.com/echasnovski/mini.surround.git> Find left surrounding │**n** │
│gzh │mini.surround <https://github.com/echasnovski/mini.surround.git> Highlight surrounding │**n** │
│gzr │mini.surround <https://github.com/echasnovski/mini.surround.git> Replace surrounding │**n** │
│gzn │mini.surround <https://github.com/echasnovski/mini.surround.git> Update MiniSurround.config.n_lines │**n** │
│<leader>fe │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (root dir) │**n** │
│<leader>fE │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (cwd) │**n** │
│<leader>e │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (root dir) │**n** │
│<leader>E │neo-tree.nvim <https://github.com/nvim-neo-tree/neo-tree.nvim.git> Explorer NeoTree (cwd) │**n** │
│<S-Enter> │noice.nvim <https://github.com/folke/noice.nvim.git> Redirect Cmdline │**c** │
│<leader>snl │noice.nvim <https://github.com/folke/noice.nvim.git> Noice Last Message │**n** │
│<leader>snh │noice.nvim <https://github.com/folke/noice.nvim.git> Noice History │**n** │
│<leader>sna │noice.nvim <https://github.com/folke/noice.nvim.git> Noice All │**n** │
│<c-f> │noice.nvim <https://github.com/folke/noice.nvim.git> Scroll forward │**n** │
│<c-b> │noice.nvim <https://github.com/folke/noice.nvim.git> Scroll backward │**n** │
│<leader>un │nvim-notify <https://github.com/rcarriga/nvim-notify.git> Delete all Notifications │**n** │
│<leader>sr │nvim-spectre <https://github.com/windwp/nvim-spectre.git> Replace in files (Spectre) │**n** │
│<c-space> │nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter.git> Increment selection │**n** │
│<c-bs> │nvim-treesitter <https://github.com/nvim-treesitter/nvim-treesitter.git> Schrink selection │**n** │
│<leader>qs │persistence.nvim <https://github.com/folke/persistence.nvim.git> Restore Session │**n** │
│<leader>ql │persistence.nvim <https://github.com/folke/persistence.nvim.git> Restore Last Session │**n** │
│<leader>qd │persistence.nvim <https://github.com/folke/persistence.nvim.git> Don’t Save Current Session │**n** │
│<leader>, │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Switch Buffer │**n** │
│<leader>/ │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find in Files (Grep) │**n** │
│<leader>: │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Command History │**n** │
│<leader><space> │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find Files (root dir) │**n** │
│<leader>fb │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Buffers │**n** │
│<leader>ff │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find Files (root dir) │**n** │
│<leader>fF │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Find Files (cwd) │**n** │
│<leader>fr │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Recent │**n** │
│<leader>gc │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> commits │**n** │
│<leader>gs │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> status │**n** │
│<leader>sa │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Auto Commands │**n** │
│<leader>sb │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Buffer │**n** │
│<leader>sc │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Command History │**n** │
│<leader>sC │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Commands │**n** │
│<leader>sg │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Grep (root dir) │**n** │
│<leader>sG │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Grep (cwd) │**n** │
│<leader>sh │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Help Pages │**n** │
│<leader>sH │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Search Highlight Groups │**n** │
│<leader>sk │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Key Maps │**n** │
│<leader>sM │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Man Pages │**n** │
│<leader>sm │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Jump to Mark │**n** │
│<leader>so │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Options │**n** │
│<leader>st │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Telescope │**n** │
│<leader>sw │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Word (root dir) │**n** │
│<leader>sW │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Word (cwd) │**n** │
│<leader>uC │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Colorscheme with preview │**n** │
│<leader>ss │telescope.nvim <https://github.com/nvim-telescope/telescope.nvim.git> Goto Symbol │**n** │
│]t │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Next todo comment │**n** │
│[t │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Previous todo comment │**n** │
│<leader>xt │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Todo Trouble │**n** │
│<leader>xtt │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Todo Trouble │**n** │
│<leader>xT │todo-comments.nvim <https://github.com/folke/todo-comments.nvim.git> Todo Telescope │**n** │
│<leader>xx │trouble.nvim <https://github.com/folke/trouble.nvim.git> Document Diagnostics (Trouble) │**n** │
│<leader>xX │trouble.nvim <https://github.com/folke/trouble.nvim.git> Workspace Diagnostics (Trouble) │**n** │
│]] │vim-illuminate <https://github.com/RRethy/vim-illuminate.git> Next Reference │**n** │
│[[ │vim-illuminate <https://github.com/RRethy/vim-illuminate.git> Prev Reference │**n** │
PLUGINS *LazyVim-plugins*
@ -608,6 +675,7 @@ Core
- tokyonight.nvim <https://github.com/folke/tokyonight.nvim>
- trouble.nvim <https://github.com/folke/trouble.nvim>
- vim-illuminate <https://github.com/RRethy/vim-illuminate>
- vim-repeat <https://github.com/tpope/vim-repeat>
- vim-startuptime <https://github.com/dstein64/vim-startuptime>
- which-key.nvim <https://github.com/folke/which-key.nvim>