mirror of https://github.com/folke/lazy.nvim.git
chore(build): auto-generate docs
This commit is contained in:
parent
6e1647c65f
commit
ba1ac9f081
|
@ -225,12 +225,12 @@ A valid spec should define one of `[1]`, `dir` or `url`.
|
||||||
## Spec Setup
|
## 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 startup |
|
||||||
| **opts** | `table` or `fun(LazyPlugin, opts:table)` | `opts` should be a table (will be merged with parent specs), return a table (replaces parent specs) or should change a table. The table will be passed to the `Plugin.config()` function. Setting this value will imply `Plugin.config()` |
|
| **opts** | `table` or `fun(LazyPlugin, opts:table)` | `opts` should be a table (will be merged with parent specs), return a table (replaces parent specs) or should change a table. The table will be passed to the `Plugin.config()` function. Setting this value will imply `Plugin.config()` |
|
||||||
| **config** | `fun(LazyPlugin, opts:table)` or `true` | `config` is executed when the plugin loads. The default implementation will automatically run `require(MAIN).setup(opts)` if `opts` or `config = true` is set. Lazy uses several heuristics to determine the plugin's `MAIN` module automatically based on the plugin's **name**. See also `opts`. To use the default implementation without `opts` set `config` to `true`. |
|
| **config** | `fun(LazyPlugin, opts:table)` or `true` | `config` is executed when the plugin loads. The default implementation will automatically run `require(MAIN).setup(opts)` if `opts` or `config = true` is set. Lazy uses several heuristics to determine the plugin's `MAIN` module automatically based on the plugin's **name**. See also `opts`. To use the default implementation without `opts` set `config` to `true`. |
|
||||||
| **main** | `string?` | You can specify the `main` module to use for `config()` and `opts()`, in case it can not be determined automatically. See `config()` |
|
| **main** | `string?` | You can specify the `main` module to use for `config()` and `opts()`, in case it can not be determined automatically. See `config()` |
|
||||||
| **build** | `fun(LazyPlugin)` or `string` or a list of build commands | `build` is executed when a plugin is installed or updated. See [Building](/developers#building) for more information. |
|
| **build** | `fun(LazyPlugin)` or `string` or `false` or a list of build commands | `build` is executed when a plugin is installed or updated. See [Building](/developers#building) for more information. |
|
||||||
|
|
||||||
## Spec Lazy Loading
|
## Spec Lazy Loading
|
||||||
|
|
||||||
|
|
|
@ -272,9 +272,9 @@ 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 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 specs),
|
||||||
|
@ -285,18 +285,19 @@ SPEC SETUP *lazy.nvim-🔌-plugin-spec-spec-setup*
|
||||||
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 set.
|
||||||
Lazy uses several heuristics to determine the plugin’s MAIN
|
Lazy uses several heuristics to determine the plugin’s
|
||||||
module automatically based on the plugin’s name. See also
|
MAIN module automatically based on the plugin’s name. See
|
||||||
opts. To use the default implementation without opts set
|
also opts. To use the default implementation without opts
|
||||||
config to true.
|
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. See
|
opts(), in case it can not be determined automatically.
|
||||||
config()
|
See config()
|
||||||
|
|
||||||
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.
|
||||||
a list of build commands See Building for more information.
|
false or a list of build See Building for more information.
|
||||||
----------------------------------------------------------------------------------------------------
|
commands
|
||||||
|
---------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
SPEC LAZY LOADING *lazy.nvim-🔌-plugin-spec-spec-lazy-loading*
|
SPEC LAZY LOADING *lazy.nvim-🔌-plugin-spec-spec-lazy-loading*
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue