subcrip
/
lazy.nvim
mirror of https://github.com/folke/lazy.nvim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2022-12-22 09:33:10 +00:00
parent 1c07ea15a3
commit a8fe63e4d5
1 changed files with 57 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/lazy.nvim.txt
View File

@ -129,7 +129,7 @@ PLUGIN SPEC *lazy.nvim-plugin-spec*
│**event** │string? or string[] │Lazy-load on event │ │**event** │string? or string[] │Lazy-load on event │
│**cmd** │string? or string[] │Lazy-load on command │ │**cmd** │string? or string[] │Lazy-load on command │
│**ft** │string? or string[] │Lazy-load on filetype │ │**ft** │string? or string[] │Lazy-load on filetype │
│**keys** │string? or string[] │Lazy-load on key mapping │ │**keys** │string? or string[] or LazyKeys[] │Lazy-load on key mapping │
│**module** │false? │Do not automatically load this lua module when it’s required somewhere │ │**module** │false? │Do not automatically load this lua module when it’s required somewhere │
@ -159,6 +159,41 @@ Plugins will be lazy-loaded when one of the following is `true`:
- `config.defaults.lazy == true` - `config.defaults.lazy == true`
*lazy.nvim-Lazy-Key-Mappings*
Lazy Key Mappings The `keys` property can be a `string` or
`string[]` for simple normal-mode
mappings, or it can be a `LazyKeys`
table with the following key-value
pairs:
- **[1]**: (`string`) lhs **_(required)_**
- **[2]**: (`string|fun()`) rhs **_(optional)_**
- **mode**: (`string|string[]`) mode **_(optional, defaults to `"n"`)_**
- any other option valid for `vim.keymap.set`
Key mappings will load the plugin the first time they get executed.
When `[2]` is `nil`, then the real mapping has to be created by the `config()`
function.
>lua
-- Example for neo-tree.nvim
{
"nvim-neo-tree/neo-tree.nvim",
keys = {
{ "<leader>ft", "<cmd>Neotree toggle<cr>", desc = "NeoTree" },
},
config = function()
require("neo-tree").setup()
end,
}
<
VERSIONING ~ VERSIONING ~
If you want to install a specific revision of a plugin, you can use `commit`, If you want to install a specific revision of a plugin, you can use `commit`,