From 652b6febf8d5c99eb8cf4a1cec63da6db62e77d2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 10 May 2023 15:26:00 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/lazy.nvim.txt | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index 3f4c0a3..3ea8a68 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -1,4 +1,4 @@ -*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 May 07 +*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 May 10 ============================================================================== Table of Contents *lazy.nvim-table-of-contents* @@ -28,7 +28,6 @@ Table of Contents *lazy.nvim-table-of-contents* FEATURES *lazy.nvim-lazy.nvim-features* - - Manage all your Neovim plugins with a powerful UI - Fast startup times thanks to automatic caching and bytecode compilation of Lua modules - Partial clones instead of shallow clones @@ -50,7 +49,6 @@ FEATURES *lazy.nvim-lazy.nvim-features* REQUIREMENTS *lazy.nvim-lazy.nvim-requirements* - - Neovim >= **0.8.0** (needs to be built with **LuaJIT**) - Git >= **2.19.0** (for partial clones support) - a Nerd Font **(optional)** @@ -83,7 +81,6 @@ Nextstep is to add **lazy.nvim** below the code added in the prior step in require("lazy").setup(plugins, opts) < - - **plugins**this should be a `table` or a `string` - `table`a list with your |lazy.nvim-plugin-spec| - `string`a Lua module name that contains your |lazy.nvim-plugin-spec|. See |lazy.nvim-structuring-your-plugins| @@ -220,7 +217,6 @@ types** and **key mappings**. Plugins will be lazy-loaded when one of the following is `true` - - Theplugin only exists as a dependency in your spec - It has an `event`, `cmd`, `ft` or `keys` key - `config.defaults.lazy == true` @@ -242,7 +238,6 @@ LAZY KEY MAPPINGS The `keys` property can be a `string` or `string[]` for simple normal-mode mappings, or it can be a `LazyKeys` table with the following key-value pairs: - - **[1]**(`string`) lhs **(required)** - **[2]**(`string|fun()`) rhs **(optional)** - **mode**(`string|string[]`) mode **(optional, defaults to "n")** @@ -276,7 +271,6 @@ The `version` property supports Semver ranges. Click to see some examples ~ - - 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`. @@ -620,7 +614,6 @@ example, if you want to sync lazy from the cmdline, you can use: `opts` is a table with the following key-values: - - **wait**when true, then the call will wait till the operation completed - **show**when false, the UI will not be shown - **plugins**a list of plugin names to run the operation on @@ -668,7 +661,6 @@ USER EVENTS ~ The following user events will be triggered: - - **LazyDone**when lazy has finished starting up and loaded your config - **LazySync**after running sync - **LazyInstall**after an install @@ -723,8 +715,10 @@ sequence for more flexibility and better performance. In practice this means that step 10 of |Neovim Initialization| is done by Lazy: - -1. All the plugins’ `init()` functions are executed2. All plugins with `lazy=false` are loaded. This includes sourcing `/plugin` and `/ftdetect` files. (`/after` will not be sourced yet)3. All files from `/plugin` and `/ftdetect` directories in you rtp are sourced (excluding `/after`)4. All `/after/plugin` files are sourced (this includes `/after` from plugins) +1. All the plugins’ `init()` functions are executed +2. All plugins with `lazy=false` are loaded. This includes sourcing `/plugin` and `/ftdetect` files. (`/after` will not be sourced yet) +3. All files from `/plugin` and `/ftdetect` directories in you rtp are sourced (excluding `/after`) +4. All `/after/plugin` files are sourced (this includes `/after` from plugins) Files from runtime directories are always sourced in alphabetical order. @@ -739,21 +733,18 @@ to the other files. The benefits of using this approach: - - Simple to **add** new plugin specs. Just create a new file in your plugins module. - Allows for **caching** of all your plugin specs. This becomes important if you have a lot of smaller plugin specs. - Spec changes will automatically be **reloaded** when they’re updated, so the `:Lazy` UI is always up to date. Example: - - `~/.config/nvim/init.lua` >lua require("lazy").setup("plugins") < - - `~/.config/nvim/lua/plugins.lua` or `~/.config/nvim/lua/plugins/init.lua` **(this file is optional)** >lua @@ -764,13 +755,11 @@ Example: } < - - Any lua file in `~/.config/nvim/lua/plugins/.lua` will be automatically merged in the main plugin spec For a real-life example, you can check LazyVim and more specifically: - - lazyvim.plugins contains all the plugin specs that will be loaded @@ -811,7 +800,6 @@ MIGRATION GUIDE *lazy.nvim-lazy.nvim-migration-guide* PACKER.NVIM ~ - - `setup` `init` - `requires` `dependencies` - `as` `name` @@ -844,7 +832,6 @@ loaded. PAQ-NVIM ~ - - `as` `name` - `opt` `lazy` - `run` `build` @@ -855,7 +842,6 @@ UNINSTALLING *lazy.nvim-lazy.nvim-uninstalling* To uninstall **lazy.nvim**, you need to remove the following files and directories: - - **data**`~/.local/share/nvim/lazy` - **state**`~/.local/state/nvim/lazy` - **lockfile**`~/.config/nvim/lazy-lock.json` @@ -934,7 +920,6 @@ Click to see all highlight groups ~ OTHER NEOVIM PLUGIN MANAGERS IN LUA*lazy.nvim-lazy.nvim-other-neovim-plugin-managers-in-lua* - - packer.nvim - paq-nvim - neopm