chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2022-12-27 16:25:37 +00:00
parent edf8310288
commit 7d20364dba
1 changed files with 25 additions and 4 deletions

View File

@ -134,6 +134,7 @@ PLUGIN SPEC *lazy.nvim-plugin-spec*
│**ft** │string? or string[] │Lazy-load on filetype │
│**keys** │string? or string[] or LazyKeys[] │Lazy-load on key mapping │
│**module** │false? │Do not automatically load this Lua module when its required somewhere │
│**priority** │number? │Only useful for **start** plugins (lazy=false) to force loading certain plugins first. Default priority is 50. Its recommended to set this to a high number for colorschemes. │
LAZY LOADING ~
@ -147,9 +148,6 @@ If you dont want this behavior for a certain plugin, you can specify that
with `module=false`. You can then manually load the plugin with `:Lazy load
foobar.nvim`.
Colorscheme plugins can be configured with `lazy=true`. The plugin will
automagically load when doing `colorscheme foobar`.
You can configure **lazy.nvim** to lazy-load all plugins by default with
`config.defaults.lazy = true`.
@ -164,6 +162,21 @@ Plugins will be lazy-loaded when one of the following is `true`:
- `config.defaults.lazy == true`
*lazy.nvim-Colorschemes*
Colorschemes Colorscheme plugins can be configured
with `lazy=true`. The plugin will
automagically load when doing
`colorscheme foobar`.
**NOTE:** since **start** plugins can possibly change existing highlight
groups, its important to make sure that your main **colorscheme** is loaded
first. To ensure this you can use the `priority=1000` field. **_(see the
examples)_**
*lazy.nvim-Lazy-Key-Mappings*
Lazy Key Mappings The `keys` property can be a `string` or
@ -227,7 +240,15 @@ EXAMPLES ~
>lua
return {
-- the colorscheme should be available when starting Neovim
"folke/tokyonight.nvim",
{
"folke/tokyonight.nvim",
lazy = false, -- make sure we load this during startup if it is your main colorscheme
priority = 1000, -- make sure to load this before all the other start plugins
config = function()
-- load the colorscheme here
vim.cmd([[colorscheme tokyonight]])
end,
},
-- I have a separate config.mappings file where I require which-key.
-- With lazy the plugin will be automatically loaded when it is required somewhere