chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2022-12-27 07:58:39 +00:00
parent 5618076a45
commit e183601763
1 changed files with 23 additions and 23 deletions

View File

@ -111,29 +111,29 @@ It is recommended to run `:checkhealth lazy` after installation
PLUGIN SPEC *lazy.nvim-plugin-spec*
│ Property │ Type │ Description │
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
│**dir** │string? │A directory pointing to a local plugin │
│**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 │
│**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 │
│**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. │
│**dependencies**│LazySpec[] │A list of plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
│**config** │fun(LazyPlugin) or true or table │config is executed when the plugin loads. You can also set to true or pass a table, that will be passed to require("plugin").setup(opts) │
│**build** │fun(LazyPlugin) or string or a list of build commands │build is executed when a plugin is installed or updated. If its 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 │
│**tag** │string? │Tag 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 │
│**pin** │boolean? │When true, this plugin will not be included in updates │
│**event** │string? or string[] │Lazy-load on event │
│**cmd** │string? or string[] │Lazy-load on command │
│**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 │
│ Property │ Type │ Description
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format
│**dir** │string? │A directory pointing to a local plugin
│**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
│**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
│**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.
│**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
│**config** │fun(LazyPlugin) or true or table │config is executed when the plugin loads. You can also set to true or pass a table, that will be passed to require("plugin").setup(opts)
│**build** │fun(LazyPlugin) or string or a list of build commands │build is executed when a plugin is installed or updated. If its 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
│**tag** │string? │Tag 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
│**pin** │boolean? │When true, this plugin will not be included in updates
│**event** │string? or string[] │Lazy-load on event
│**cmd** │string? or string[] │Lazy-load on command
│**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
LAZY LOADING ~