Skip to content

Commit fe9f936

Browse files
chore(build): auto-generate vimdoc
1 parent 24f6b6f commit fe9f936

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

doc/lazy.nvim.txt

+44-44
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 August 26
1+
*lazy.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 September 27
22

33
==============================================================================
44
Table of Contents *lazy.nvim-table-of-contents*
@@ -160,7 +160,7 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
160160
build fun(LazyPlugin) or string or a list of build commands build is executed when a plugin is installed or
161161
updated. Before running build, a plugin is first
162162
loaded. If it’s a string it will be ran as a shell
163-
command. When prefixed with it is a Neovim command.
163+
command. When prefixed with : it is a Neovim command.
164164
You can also specify a list to executed multiple build
165165
commands. Some plugins provide their own build.lua
166166
which is automatically used by lazy. So no need to
@@ -181,7 +181,7 @@ PLUGIN SPEC *lazy.nvim-lazy.nvim-plugin-spec*
181181
Defaults to true
182182

183183
event string? or string[] or Lazy-load on event. Events can be specified as
184-
fun(self:LazyPlugin, event:string[]):string[] BufEnter or with a pattern like BufEnter .lua
184+
fun(self:LazyPlugin, event:string[]):string[] BufEnter or with a pattern like BufEnter *.lua
185185

186186
cmd string? or string[] or Lazy-load on command
187187
fun(self:LazyPlugin, cmd:string[]):string[]
@@ -281,7 +281,7 @@ The `version` property supports Semver <https://semver.org/> ranges.
281281

282282
Click to see some examples ~
283283

284-
- latest stable version (this excludes pre-release versions)
284+
- `*`latest stable version (this excludes pre-release versions)
285285
- `1.2.x`any version that starts with `1.2`, such as `1.2.0`, `1.2.3`, etc.
286286
- `^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`.
287287
- `~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 ~
290290
- `<1.2.3`any version that is less than `1.2.3`, such as `1.1.0`, `1.0.5`, etc.
291291
- `<=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
292292

293-
You can set `config.defaults.version = ""` to install the latest stable version
294-
of plugins that support Semver.
293+
You can set `config.defaults.version = "*"` to install the latest stable
294+
version of plugins that support Semver.
295295

296296

297297
EXAMPLES ~
@@ -400,12 +400,12 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
400400
-- default `cond` you can use to globally disable a lot of plugins
401401
-- when running inside vscode for example
402402
cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil
403-
-- version = "", -- enable this to try installing the latest stable versions of plugins
403+
-- version = "*", -- enable this to try installing the latest stable versions of plugins
404404
},
405405
-- leave nil when passing the spec as the first argument to setup()
406406
spec = nil, ---@type LazySpec
407407
lockfile = vim.fn.stdpath("config") .. "/lazy-lock.json", -- lockfile generated after running update.
408-
concurrency = jit.os:find("Windows") and (vim.loop.available_parallelism() 2) or nil, ---@type number limit the maximum amount of concurrent tasks
408+
concurrency = jit.os:find("Windows") and (vim.loop.available_parallelism() * 2) or nil, ---@type number limit the maximum amount of concurrent tasks
409409
git = {
410410
-- defaults for the `Lazy log` command
411411
-- log = { "-10" }, -- show the last 10 commits
@@ -441,25 +441,25 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
441441
-- Show pills on top of the Lazy window
442442
pills = true, ---@type boolean
443443
icons = {
444-
cmd = " ",
445-
config = "",
446-
event = "",
447-
ft = " ",
448-
init = " ",
449-
import = " ",
450-
keys = " ",
444+
cmd = " ",
445+
config = "",
446+
event = "",
447+
ft = " ",
448+
init = " ",
449+
import = " ",
450+
keys = " ",
451451
lazy = "󰒲 ",
452-
loaded = "",
453-
not_loaded = "",
454-
plugin = " ",
455-
runtime = " ",
456-
source = " ",
457-
start = "",
458-
task = " ",
452+
loaded = "",
453+
not_loaded = "",
454+
plugin = " ",
455+
runtime = " ",
456+
source = " ",
457+
start = "",
458+
task = " ",
459459
list = {
460-
"",
461-
"",
462-
"",
460+
"",
461+
"",
462+
"",
463463
"‒",
464464
},
465465
},
@@ -488,11 +488,11 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
488488
},
489489
diff = {
490490
-- diff command <d> can be one of:
491-
-- browser: opens the github compare view. Note that this is always mapped to <K> as well,
491+
-- * browser: opens the github compare view. Note that this is always mapped to <K> as well,
492492
-- so you can have a different command for diff <d>
493-
-- git: will run git diff and open a buffer with filetype git
494-
-- terminal_git: will open a pseudo terminal with git diff
495-
-- diffview.nvim: will open Diffview to show the diff
493+
-- * git: will run git diff and open a buffer with filetype git
494+
-- * terminal_git: will open a pseudo terminal with git diff
495+
-- * diffview.nvim: will open Diffview to show the diff
496496
cmd = "git",
497497
},
498498
checker = {
@@ -535,7 +535,7 @@ CONFIGURATION *lazy.nvim-lazy.nvim-configuration*
535535
readme = {
536536
enabled = true,
537537
root = vim.fn.stdpath("state") .. "/lazy/readme",
538-
files = { "README.md", "lua//README.md" },
538+
files = { "README.md", "lua/**/README.md" },
539539
-- only generate markdown helptags for plugins that dont have docs
540540
skip_if_doc_exists = true,
541541
},
@@ -556,17 +556,17 @@ If you don’t want to use a Nerd Font, you can replace the icons with Unicode s
556556
ui = {
557557
icons = {
558558
cmd = "⌘",
559-
config = "",
560-
event = "",
561-
ft = "",
562-
init = "",
563-
keys = "",
564-
plugin = "",
565-
runtime = "",
566-
source = "",
567-
start = "",
568-
task = "",
569-
lazy = " ",
559+
config = "🛠",
560+
event = "📅",
561+
ft = "📂",
562+
init = "",
563+
keys = "🗝",
564+
plugin = "🔌",
565+
runtime = "💻",
566+
source = "📄",
567+
start = "🚀",
568+
task = "📌",
569+
lazy = "💤 ",
570570
},
571571
},
572572
}
@@ -671,7 +671,7 @@ Example of configuring lualine.nvim ~
671671
{
672672
require("lazy.status").updates,
673673
cond = require("lazy.status").has_updates,
674-
color = { fg = "ff9e64" },
674+
color = { fg = "#ff9e64" },
675675
},
676676
},
677677
},
@@ -784,7 +784,7 @@ Example:
784784
}
785785
<
786786

787-
- Any lua file in `~/.config/nvim/lua/plugins/.lua` will be automatically merged in the main plugin spec
787+
- Any lua file in `~/.config/nvim/lua/plugins/*.lua` will be automatically merged in the main plugin spec
788788

789789
For a real-life example, you can check LazyVim
790790
<https://github.com/LazyVim/LazyVim> and more specifically:
@@ -836,7 +836,7 @@ PACKER.NVIM ~
836836
- `run` `build`
837837
- `lock` `pin`
838838
- `disable=true` `enabled = false`
839-
- `tag=''` `version=""`
839+
- `tag='*'` `version="*"`
840840
- `after` **not needed** for most use-cases. Use `dependencies` otherwise.
841841
- `wants` **not needed** for most use-cases. Use `dependencies` otherwise.
842842
- `config` don’t support string type, use `fun(LazyPlugin)` instead.

0 commit comments

Comments
 (0)