subcrip
/
lazy.nvim
mirror of https://github.com/folke/lazy.nvim.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2023-06-30 16:29:13 +00:00
parent 2ea3c54b5f
commit d54ae0b96d
1 changed files with 45 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
doc/lazy.nvim.txt
View File

@ -18,6 +18,7 @@ Table of Contents *lazy.nvim-table-of-contents*
- Migration Guide |lazy.nvim-lazy.nvim-migration-guide| - Migration Guide |lazy.nvim-lazy.nvim-migration-guide|
- Uninstalling |lazy.nvim-lazy.nvim-uninstalling| - Uninstalling |lazy.nvim-lazy.nvim-uninstalling|
- Highlight Groups |lazy.nvim-lazy.nvim-highlight-groups| - Highlight Groups |lazy.nvim-lazy.nvim-highlight-groups|
- Plugin Authors |lazy.nvim-lazy.nvim-plugin-authors|
- Other Neovim Plugin Managers in Lua|lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua| - Other Neovim Plugin Managers in Lua|lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua|
============================================================================== ==============================================================================
@ -102,9 +103,9 @@ It is recommended to run `:checkhealth lazy` after installation.
PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec* PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
-------------------------------------------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------------
Property Type Description Property Type Description
-------------- ------------------------------------------------------------ ---------------------------------------------------- -------------- ------------------------------------------------------------ ------------------------------------------------------
[1] string? Short plugin url. Will be expanded using [1] string? Short plugin url. Will be expanded using
config.git.url_format config.git.url_format
@ -112,40 +113,40 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
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 name string? A custom name for the plugin used for the local plugin
plugin directory and as the display name directory and as the display name
dev boolean? When true, a local plugin directory will be used dev boolean? When true, a local plugin directory will be used
instead. See config.dev instead. See config.dev
lazy boolean? When true, the plugin will only be loaded when lazy boolean? When true, the plugin will only be loaded when needed.
needed. Lazy-loaded plugins are automatically loaded Lazy-loaded plugins are automatically loaded when
when their Lua modules are required, or when one of their Lua modules are required, or when one of the
the lazy-loading handlers triggers lazy-loading handlers triggers
enabled boolean? or fun():boolean When false, or if the function returns false, then enabled boolean? or fun():boolean When false, or if the function returns false, then
this plugin will not be included in the spec this plugin will not be included in the spec
cond boolean? or fun(LazyPlugin):boolean When false, or if the function returns false, then cond boolean? or fun(LazyPlugin):boolean When false, or if the function returns false, then
this plugin will not be loaded. Useful to disable this plugin will not be loaded. Useful to disable some
some plugins in vscode, or firenvim for example. plugins in vscode, or firenvim for example.
dependencies LazySpec[] A list of plugin names or plugin specs that should dependencies LazySpec[] A list of plugin names or plugin specs that should be
be loaded when the plugin loads. Dependencies are loaded when the plugin loads. Dependencies are always
always lazy-loaded unless specified otherwise. When lazy-loaded unless specified otherwise. When
specifying a name, make sure the plugin spec has specifying a name, make sure the plugin spec has been
been defined somewhere else. 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 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 specs), return a table (replaces parent specs) or
should change a table. The table will be passed to should change a table. The table will be passed to the
the Plugin.config() function. Setting this value Plugin.config() function. Setting this value will
will imply Plugin.config() imply Plugin.config()
config fun(LazyPlugin, opts:table) or true config is executed when the plugin loads. The config fun(LazyPlugin, opts:table) or true config is executed when the plugin loads. The default
default implementation will automatically run implementation will automatically run
require(MAIN).setup(opts). Lazy uses several require(MAIN).setup(opts). Lazy uses several
heuristics to determine the plugin’s MAIN module heuristics to determine the plugin’s MAIN module
automatically based on the plugin’s name. See also automatically based on the plugin’s name. See also
@ -160,8 +161,10 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
updated. Before running build, a plugin is first updated. Before running build, a plugin is first
loaded. If it’s a string it will be ran as a shell loaded. If it’s a string it will be ran as a shell
command. When prefixed with it is a Neovim command. command. When prefixed with it is a Neovim command.
You can also specify a list to executed multiple You can also specify a list to executed multiple build
build commands commands. Some plugins provide their own build.lua
which is automatically used by lazy. So no need to
specify a build step for those plugins.
branch string? Branch of the repository branch string? Branch of the repository
@ -169,11 +172,10 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
commit string? Commit of the repository commit string? Commit of the repository
version string? or false to override the default Version to use from the repository. Full Semver version string? or false to override the default Version to use from the repository. Full Semver ranges
ranges are supported are supported
pin boolean? When true, this plugin will not be included in pin boolean? When true, this plugin will not be included in updates
updates
submodules boolean? When false, git submodules will not be fetched. submodules boolean? When false, git submodules will not be fetched.
Defaults to true Defaults to true
@ -194,17 +196,17 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
required somewhere required somewhere
priority number? Only useful for start plugins (lazy=false) to force priority number? Only useful for start plugins (lazy=false) to force
loading certain plugins first. Default priority is loading certain plugins first. Default priority is 50.
50. It’s recommended to set this to a high number It’s recommended to set this to a high number for
for colorschemes. colorschemes.
optional boolean? When a spec is tagged optional, it will only be optional boolean? When a spec is tagged optional, it will only be
included in the final spec, when the same plugin has included in the final spec, when the same plugin has
been specified at least once somewhere else without been specified at least once somewhere else without
optional. This is mainly useful for Neovim distros, optional. This is mainly useful for Neovim distros, to
to allow setting options on plugins that may/may not allow setting options on plugins that may/may not be
be part of the user’s plugins part of the user’s plugins
-------------------------------------------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------------
LAZY LOADING ~ LAZY LOADING ~
@ -936,6 +938,16 @@ Click to see all highlight groups ~
LazyValue _@string_ valueof a property LazyValue _@string_ valueof a property
--------------------------------------------------------------------------------- ---------------------------------------------------------------------------------
PLUGIN AUTHORS *lazy.nvim-lazy.nvim-plugin-authors*
If your plugin needs a build step, you can create a file `build.lua` or
`build/init.lua` in the root of your repo. This file will be loaded when the
plugin is installed or updated.
This makes it easier for users, so they no longer need to specify a `build`
command.
OTHER NEOVIM PLUGIN MANAGERS IN LUA*lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua* OTHER NEOVIM PLUGIN MANAGERS IN LUA*lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua*
- packer.nvim <https://github.com/wbthomason/packer.nvim> - packer.nvim <https://github.com/wbthomason/packer.nvim>