mirror of https://github.com/folke/lazy.nvim.git
chore(build): auto-generate docs
This commit is contained in:
parent
baac551777
commit
a1d23e80ba
|
@ -291,23 +291,25 @@ SPEC LOADING *lazy.nvim-🔌-plugin-spec-spec-loading*
|
||||||
|
|
||||||
SPEC SETUP *lazy.nvim-🔌-plugin-spec-spec-setup*
|
SPEC SETUP *lazy.nvim-🔌-plugin-spec-spec-setup*
|
||||||
|
|
||||||
---------------------------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------------------------
|
||||||
Property Type Description
|
Property Type Description
|
||||||
---------- ----------------------------- ----------------------------------------------------------
|
---------- ----------------------------- ---------------------------------------------------------
|
||||||
init fun(LazyPlugin) init functions are always executed during startup
|
init fun(LazyPlugin) init functions are always executed during. Mostly useful
|
||||||
|
for setting vim.g.* configuration used by Vim plugins
|
||||||
|
startup
|
||||||
|
|
||||||
opts table or opts should be a table (will be merged with parent specs),
|
opts table or opts should be a table (will be merged with parent
|
||||||
fun(LazyPlugin, opts:table) return a table (replaces parent specs) or should change a
|
fun(LazyPlugin, opts:table) specs), return a table (replaces parent specs) or should
|
||||||
table. The table will be passed to the Plugin.config()
|
change a table. The table will be passed to the
|
||||||
function. Setting this value will imply Plugin.config()
|
Plugin.config() function. Setting this value will imply
|
||||||
|
Plugin.config()
|
||||||
|
|
||||||
config fun(LazyPlugin, opts:table) config is executed when the plugin loads. The default
|
config fun(LazyPlugin, opts:table) config is executed when the plugin loads. The default
|
||||||
or true implementation will automatically run
|
or true implementation will automatically run
|
||||||
require(MAIN).setup(opts) if opts or config = true is set.
|
require(MAIN).setup(opts) if opts or config = true is
|
||||||
Lazy uses several heuristics to determine the plugin’s
|
set. Lazy uses several heuristics to determine the
|
||||||
MAIN module automatically based on the plugin’s name. See
|
plugin’s MAIN module automatically based on the plugin’s
|
||||||
also opts. To use the default implementation without opts
|
name. (opts is the recommended way to configure plugins).
|
||||||
set config to true.
|
|
||||||
|
|
||||||
main string? You can specify the main module to use for config() and
|
main string? You can specify the main module to use for config() and
|
||||||
opts(), in case it can not be determined automatically.
|
opts(), in case it can not be determined automatically.
|
||||||
|
@ -316,7 +318,12 @@ SPEC SETUP *lazy.nvim-🔌-plugin-spec-spec-setup*
|
||||||
build fun(LazyPlugin) or string or build is executed when a plugin is installed or updated.
|
build fun(LazyPlugin) or string or build is executed when a plugin is installed or updated.
|
||||||
false or a list of build See Building for more information.
|
false or a list of build See Building for more information.
|
||||||
commands
|
commands
|
||||||
---------------------------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------------------------
|
||||||
|
Always use `opts` instead of `config` when possible. `config` is almost never
|
||||||
|
needed.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
SPEC LAZY LOADING *lazy.nvim-🔌-plugin-spec-spec-lazy-loading*
|
SPEC LAZY LOADING *lazy.nvim-🔌-plugin-spec-spec-lazy-loading*
|
||||||
|
|
||||||
|
@ -1241,6 +1248,8 @@ BEST PRACTICES *lazy.nvim-🔥-developers-best-practices*
|
||||||
>lua
|
>lua
|
||||||
{ "nvim-lua/plenary.nvim", lazy = true }
|
{ "nvim-lua/plenary.nvim", lazy = true }
|
||||||
<
|
<
|
||||||
|
- Always use `opts` instead of `config` when possible. `config` is almost never
|
||||||
|
needed.
|
||||||
- Only use `dependencies` if a plugin needs the dep to be installed **AND**
|
- Only use `dependencies` if a plugin needs the dep to be installed **AND**
|
||||||
loaded. Lua plugins/libraries are automatically loaded when they are
|
loaded. Lua plugins/libraries are automatically loaded when they are
|
||||||
`require()`d, so they don’t need to be in `dependencies`.
|
`require()`d, so they don’t need to be in `dependencies`.
|
||||||
|
|
Loading…
Reference in New Issue