mirror of https://github.com/folke/lazy.nvim.git
chore(build): auto-generate vimdoc
This commit is contained in:
github-actions[bot]
parent
24f6b6f1c7
commit
fe9f93692e
|
|
@ -1,4 +1,4 @@
|
|||
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 August 26
|
||||
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 September 27
|
||||
|
||||
==============================================================================
|
||||
Table of Contents *lazy.nvim-table-of-contents*
|
||||
|
|
@ -160,7 +160,7 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
|
|||
build fun(LazyPlugin) or string or a list of build commands build is executed when a plugin is installed or
|
||||
updated. Before running build, a plugin is first
|
||||
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 build
|
||||
commands. Some plugins provide their own build.lua
|
||||
which is automatically used by lazy. So no need to
|
||||
|
|
@ -181,7 +181,7 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
|
|||
Defaults to true
|
||||
|
||||
event string? or string[] or Lazy-load on event. Events can be specified as
|
||||
fun(self:LazyPlugin, event:string[]):string[] BufEnter or with a pattern like BufEnter .lua
|
||||
fun(self:LazyPlugin, event:string[]):string[] BufEnter or with a pattern like BufEnter *.lua
|
||||
|
||||
cmd string? or string[] or Lazy-load on command
|
||||
fun(self:LazyPlugin, cmd:string[]):string[]
|
||||
|
|
@ -281,7 +281,7 @@ The `version` property supports Semver <https://semver.org/> ranges.
|
|||
|
||||
Click to see some examples ~
|
||||
|
||||
- latest stable version (this excludes pre-release versions)
|
||||
- `*`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`.
|
||||
|
|
@ -290,8 +290,8 @@ Click to see some examples ~
|
|||
- `<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.
|
||||
You can set `config.defaults.version = "*"` to install the latest stable
|
||||
version of plugins that support Semver.
|
||||
|
||||
|
||||
EXAMPLES ~
|
||||
|
|
@ -400,12 +400,12 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
|
|||
-- default `cond` you can use to globally disable a lot of plugins
|
||||
-- when running inside vscode for example
|
||||
cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil
|
||||
-- version = "", -- enable this to try installing the latest stable versions of plugins
|
||||
-- version = "*", -- enable this to try installing the latest stable versions of plugins
|
||||
},
|
||||
-- leave nil when passing the spec as the first argument to setup()
|
||||
spec = nil, ---@type LazySpec
|
||||
lockfile = vim.fn.stdpath("config") .. "/lazy-lock.json", -- lockfile generated after running update.
|
||||
concurrency = jit.os:find("Windows") and (vim.loop.available_parallelism() 2) or nil, ---@type number limit the maximum amount of concurrent tasks
|
||||
concurrency = jit.os:find("Windows") and (vim.loop.available_parallelism() * 2) or nil, ---@type number limit the maximum amount of concurrent tasks
|
||||
git = {
|
||||
-- defaults for the `Lazy log` command
|
||||
-- log = { "-10" }, -- show the last 10 commits
|
||||
|
|
@ -441,25 +441,25 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
|
|||
-- Show pills on top of the Lazy window
|
||||
pills = true, ---@type boolean
|
||||
icons = {
|
||||
cmd = " ",
|
||||
config = "",
|
||||
event = "",
|
||||
ft = " ",
|
||||
init = " ",
|
||||
import = " ",
|
||||
keys = " ",
|
||||
cmd = " ",
|
||||
config = "",
|
||||
event = "",
|
||||
ft = " ",
|
||||
init = " ",
|
||||
import = " ",
|
||||
keys = " ",
|
||||
lazy = " ",
|
||||
loaded = "",
|
||||
not_loaded = "",
|
||||
plugin = " ",
|
||||
runtime = " ",
|
||||
source = " ",
|
||||
start = "",
|
||||
task = " ",
|
||||
loaded = "●",
|
||||
not_loaded = "○",
|
||||
plugin = " ",
|
||||
runtime = " ",
|
||||
source = " ",
|
||||
start = "",
|
||||
task = "✔ ",
|
||||
list = {
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"●",
|
||||
"➜",
|
||||
"★",
|
||||
"‒",
|
||||
},
|
||||
},
|
||||
|
|
@ -488,11 +488,11 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
|
|||
},
|
||||
diff = {
|
||||
-- diff command <d> can be one of:
|
||||
-- browser: opens the github compare view. Note that this is always mapped to <K> as well,
|
||||
-- * browser: opens the github compare view. Note that this is always mapped to <K> as well,
|
||||
-- so you can have a different command for diff <d>
|
||||
-- git: will run git diff and open a buffer with filetype git
|
||||
-- terminal_git: will open a pseudo terminal with git diff
|
||||
-- diffview.nvim: will open Diffview to show the diff
|
||||
-- * git: will run git diff and open a buffer with filetype git
|
||||
-- * terminal_git: will open a pseudo terminal with git diff
|
||||
-- * diffview.nvim: will open Diffview to show the diff
|
||||
cmd = "git",
|
||||
},
|
||||
checker = {
|
||||
|
|
@ -535,7 +535,7 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
|
|||
readme = {
|
||||
enabled = true,
|
||||
root = vim.fn.stdpath("state") .. "/lazy/readme",
|
||||
files = { "README.md", "lua//README.md" },
|
||||
files = { "README.md", "lua/**/README.md" },
|
||||
-- only generate markdown helptags for plugins that dont have docs
|
||||
skip_if_doc_exists = true,
|
||||
},
|
||||
|
|
@ -556,17 +556,17 @@ If you don’t want to use a Nerd Font, you can replace the icons with Unicode s
|
|||
ui = {
|
||||
icons = {
|
||||
cmd = "⌘",
|
||||
config = "",
|
||||
event = "",
|
||||
ft = "",
|
||||
init = "",
|
||||
keys = "",
|
||||
plugin = "",
|
||||
runtime = "",
|
||||
source = "",
|
||||
start = "",
|
||||
task = "",
|
||||
lazy = " ",
|
||||
config = "🛠",
|
||||
event = "📅",
|
||||
ft = "📂",
|
||||
init = "⚙",
|
||||
keys = "🗝",
|
||||
plugin = "🔌",
|
||||
runtime = "💻",
|
||||
source = "📄",
|
||||
start = "🚀",
|
||||
task = "📌",
|
||||
lazy = "💤 ",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
|
@ -671,7 +671,7 @@ Example of configuring lualine.nvim ~
|
|||
{
|
||||
require("lazy.status").updates,
|
||||
cond = require("lazy.status").has_updates,
|
||||
color = { fg = "ff9e64" },
|
||||
color = { fg = "#ff9e64" },
|
||||
},
|
||||
},
|
||||
},
|
||||
|
|
@ -784,7 +784,7 @@ Example:
|
|||
}
|
||||
<
|
||||
|
||||
- Any lua file in `~/.config/nvim/lua/plugins/.lua` will be automatically merged in the main plugin spec
|
||||
- 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
|
||||
<https://github.com/LazyVim/LazyVim> and more specifically:
|
||||
|
|
@ -836,7 +836,7 @@ PACKER.NVIM ~
|
|||
- `run` `build`
|
||||
- `lock` `pin`
|
||||
- `disable=true` `enabled = false`
|
||||
- `tag=''` `version=""`
|
||||
- `tag='*'` `version="*"`
|
||||
- `after` **not needed** for most use-cases. Use `dependencies` otherwise.
|
||||
- `wants` **not needed** for most use-cases. Use `dependencies` otherwise.
|
||||
- `config` don’t support string type, use `fun(LazyPlugin)` instead.
|
||||
|
|
|
|||
Loading…
Reference in New Issue