mirror of https://github.com/folke/lazy.nvim.git
chore(build): auto-generate vimdoc
This commit is contained in:
github-actions[bot]
parent
1b219c1704
commit
9375f68dcd
|
|
@ -111,31 +111,31 @@ It is recommended to run `:checkhealth lazy` after installation
|
||||||
|
|
||||||
PLUGIN SPEC *lazy.nvim-plugin-spec*
|
PLUGIN SPEC *lazy.nvim-plugin-spec*
|
||||||
|
|
||||||
│ Property │ Type │ Description │
|
│ Property │ Type │ Description │
|
||||||
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
|
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
|
||||||
│**dir** │string? │A directory pointing to a local plugin │
|
│**dir** │string? │A directory pointing to a local plugin │
|
||||||
│**url** │string? │A custom git url where the plugin is hosted │
|
│**url** │string? │A custom git url where the plugin is hosted │
|
||||||
│**name** │string? │A custom name for the plugin used for the local plugin directory and as the display name │
|
│**name** │string? │A custom name for the plugin used for the local plugin directory and as the display name │
|
||||||
│**dev** │boolean? │When true, a local plugin directory will be used instead. See config.dev │
|
│**dev** │boolean? │When true, a local plugin directory will be used instead. See config.dev │
|
||||||
│**lazy** │boolean? │When true, the plugin will only be loaded when needed. Lazy-loaded plugins are automatically loaded when their Lua modules are required, or when one of the lazy-loading handlers triggers │
|
│**lazy** │boolean? │When true, the plugin will only be loaded when needed. Lazy-loaded plugins are automatically loaded when their Lua modules are required, or when one of the lazy-loading handlers triggers │
|
||||||
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be included in the spec │
|
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be included in the spec │
|
||||||
│**cond** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be loaded. Useful to disable some plugins in vscode, or firenvim for example. │
|
│**cond** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be loaded. Useful to disable some plugins in vscode, or firenvim for example. │
|
||||||
│**dependencies**│LazySpec[] │A list of plugin names or plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise. When specifying a name, make sure the plugin spec has been defined somewhere else. │
|
│**dependencies**│LazySpec[] │A list of plugin names or plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise. When specifying a name, make sure the plugin spec has been defined somewhere else. │
|
||||||
│**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("plugin").setup(opts). 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("plugin").setup(opts). "plugin" will default to name if specified, otherwise lazy.nvim will do its best to guess the correct plugin name. See also opts. To use the default implementation without opts set config to true. │
|
||||||
│**build** │fun(LazyPlugin) or string or a list of build commands │build is executed when a plugin is installed or updated. If it’s a string it will be ran as a shell command. When prefixed with : it is a Neovim command. You can also specify a list to executed multiple build commands │
|
│**build** │fun(LazyPlugin) or string or a list of build commands │build is executed when a plugin is installed or updated. If it’s a string it will be ran as a shell command. When prefixed with : it is a Neovim command. You can also specify a list to executed multiple build commands │
|
||||||
│**branch** │string? │Branch of the repository │
|
│**branch** │string? │Branch of the repository │
|
||||||
│**tag** │string? │Tag of the repository │
|
│**tag** │string? │Tag of the repository │
|
||||||
│**commit** │string? │Commit of the repository │
|
│**commit** │string? │Commit of the repository │
|
||||||
│**version** │string? │Version to use from the repository. Full Semver <https://devhints.io/semver> ranges are supported │
|
│**version** │string? │Version to use from the repository. Full Semver <https://devhints.io/semver> ranges are supported │
|
||||||
│**pin** │boolean? │When true, this plugin will not be included in updates │
|
│**pin** │boolean? │When true, this plugin will not be included in updates │
|
||||||
│**event** │string? or string[] or fun(self:LazyPlugin, event:string[]):string[] │Lazy-load on event. Events can be specified as BufEnter or with a pattern like BufEnter .lua │
|
│**event** │string? or string[] or fun(self:LazyPlugin, event:string[]):string[] │Lazy-load on event. Events can be specified as BufEnter or with a pattern like BufEnter .lua │
|
||||||
│**cmd** │string? or string[] or fun(self:LazyPlugin, cmd:string[]):string[] │Lazy-load on command │
|
│**cmd** │string? or string[] or fun(self:LazyPlugin, cmd:string[]):string[] │Lazy-load on command │
|
||||||
│**ft** │string? or string[] or fun(self:LazyPlugin, ft:string[]):string[] │Lazy-load on filetype │
|
│**ft** │string? or string[] or fun(self:LazyPlugin, ft:string[]):string[] │Lazy-load on filetype │
|
||||||
│**keys** │string? or string[] or LazyKeys[] or fun(self:LazyPlugin, keys:string[]):(string \| LazyKeys)[] │Lazy-load on key mapping │
|
│**keys** │string? or string[] or LazyKeys[] or fun(self:LazyPlugin, keys:string[]):(string \| 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 │
|
||||||
│**priority** │number? │Only useful for **start** plugins (lazy=false) to force loading certain plugins first. Default priority is 50. It’s recommended to set this to a high number for colorschemes. │
|
│**priority** │number? │Only useful for **start** plugins (lazy=false) to force loading certain plugins first. Default priority is 50. It’s recommended to set this to a high number for colorschemes. │
|
||||||
|
|
||||||
|
|
||||||
LAZY LOADING ~
|
LAZY LOADING ~
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue