Skip to content

Commit e183601

Browse files
github-actions[bot]github-actions[bot]
committed
chore(build): auto-generate vimdoc
1 parent 5618076 commit e183601

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

‎doc/lazy.nvim.txt

+23-23
Original file line numberDiff line numberDiff line change
@@ -111,29 +111,29 @@ It is recommended to run `:checkhealth lazy` after installation
111111

112112
PLUGIN SPEC *lazy.nvim-plugin-spec*
113113

114-
│ Property │ Type │ Description │
115-
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
116-
│**dir** │string? │A directory pointing to a local plugin │
117-
│**url** │string? │A custom git url where the plugin is hosted │
118-
│**name** │string? │A custom name for the plugin used for the local plugin directory and as the display name │
119-
│**dev** │boolean? │When true, a local plugin directory will be used instead. See config.dev │
120-
│**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 │
121-
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be included in the spec │
122-
│**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. │
123-
│**dependencies**│LazySpec[] │A list of plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise │
124-
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
125-
│**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) │
126-
│**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 │
127-
│**branch** │string? │Branch of the repository │
128-
│**tag** │string? │Tag of the repository │
129-
│**commit** │string? │Commit of the repository │
130-
│**version** │string? │Version to use from the repository. Full Semver <https://devhints.io/semver> ranges are supported │
131-
│**pin** │boolean? │When true, this plugin will not be included in updates │
132-
│**event** │string? or string[] │Lazy-load on event │
133-
│**cmd** │string? or string[] │Lazy-load on command │
134-
│**ft** │string? or string[] │Lazy-load on filetype │
135-
│**keys** │string? or string[] or LazyKeys[] │Lazy-load on key mapping │
136-
│**module** │false? │Do not automatically load this Lua module when it’s required somewhere │
114+
│ Property │ Type │ Description │
115+
│[1] │string? │Short plugin url. Will be expanded using config.git.url_format │
116+
│**dir** │string? │A directory pointing to a local plugin │
117+
│**url** │string? │A custom git url where the plugin is hosted │
118+
│**name** │string? │A custom name for the plugin used for the local plugin directory and as the display name │
119+
│**dev** │boolean? │When true, a local plugin directory will be used instead. See config.dev │
120+
│**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 │
121+
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be included in the spec │
122+
│**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. │
123+
│**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.│
124+
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
125+
│**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) │
126+
│**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 │
127+
│**branch** │string? │Branch of the repository │
128+
│**tag** │string? │Tag of the repository │
129+
│**commit** │string? │Commit of the repository │
130+
│**version** │string? │Version to use from the repository. Full Semver <https://devhints.io/semver> ranges are supported │
131+
│**pin** │boolean? │When true, this plugin will not be included in updates │
132+
│**event** │string? or string[] │Lazy-load on event │
133+
│**cmd** │string? or string[] │Lazy-load on command │
134+
│**ft** │string? or string[] │Lazy-load on filetype │
135+
│**keys** │string? or string[] or LazyKeys[] │Lazy-load on key mapping │
136+
│**module** │false? │Do not automatically load this Lua module when it’s required somewhere │
137137

138138

139139
LAZY LOADING ~

0 commit comments

Comments
 (0)