From 39f629eedff84edd216987d58152ce782779d3c8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 18 Dec 2022 13:29:46 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/lazy.nvim.txt | 58 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index 61ecd23..d549ec0 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -121,6 +121,64 @@ PLUGIN SPEC *lazy.nvim-plugin-spec* │**keys** │string? or string[] │Lazy-load on key mapping │ +LAZY LOADING ~ + +**lazy.nvim** automagically lazy-loads Lua modules, so it is not needed to +specify `module=...` everywhere in your plugin specification. This mean that if +you have a plugin `A` that is lazy-loaded and a plugin `B` that requires a +module of plugin `A`, then plugin `A` will be loaded on demand as expected. + +You can configure **lazy.nvim** to lazy-load all plugins by default with +`config.defaults.lazy = true`. + +Additionally, you can also lazy-load on **events**, **commands**, **file +types** and **key mappings**. + +Plugins will be lazy-loaded when one of the following is `true`: + + +- the plugin only exists as a dependency in your spec +- it has an `event`, `cmd`, `ft` or `cmd` key +- it defines an `init` method +- `config.defaults.lazy == true` + + +VERSIONING ~ + +If you want to install a specific revision of a plugin, you can use `commit`, +`tag`, `branch`, `version`. + +The `version` property supports Semver ranges: + + +- :latest stable version (this excludes pre-release versions) +- `1.2.x`: any version that starts with `1.2`, such as `1.2.0`, `1.2.3`, etc. +- `^1.2.3`: any version that is compatible with `1.2.3`, such as `1.3.0`, `1.4.5`, etc., but not `2.0.0`. +- `~1.2.3`: any version that is compatible with `1.2.3`, such as `1.2.4`, `1.2.5`, but not `1.3.0`. +- `>1.2.3`: any version that is greater than `1.2.3`, such as `1.3.0`, `1.4.5`, etc. +- `>=1.2.3`: any version that is greater than or equal to `1.2.3`, such as `1.2.3`, `1.3.0`, `1.4.5`, etc. +- `<1.2.3`: any version that is less than `1.2.3`, such as `1.1.0`, `1.0.5`, etc. +- `<=1.2.3`: any version that is less than or equal to `1.2.3`, such as `1.2.3`, `1.1.0`, `1.0.5`, etc + + + + You can set `config.defaults.version = ""` to install the latest stable version + of plugins that support Semver. + + +EXAMPLES ~ + +My personal dots: + + +- init.lua where I require `config.lazy` +- config.lazy where I bootstrap and setup **lazy.nvim** +- config.plugins is my main plugin config module +- Any submodule of config.plugins (submodules) will be automatically loaded as well. + + +Other examples: + >lua return { -- the colorscheme should be available when starting Neovim