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 docs

This commit is contained in:
github-actions[bot] 2024-06-23 17:49:33 +00:00
parent f6a98dbd81
commit c7a0df45d5
3 changed files with 104 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -656,39 +656,39 @@ with a lazy extension in `lazy`.
# 🌈 Highlight Groups # 🌈 Highlight Groups
| Highlight Group | Default Group | Description | | Highlight Group | Default Group | Description |
| --------------------- | -------------------------- | --------------------------------------------------- | | --- | --- | --- |
| **LazyButton** | **_CursorLine_** | | | **LazyButton** | ***CursorLine*** | |
| **LazyButtonActive** | **_Visual_** | | | **LazyButtonActive** | ***Visual*** | |
| **LazyComment** | **_Comment_** | | | **LazyComment** | ***Comment*** | |
| **LazyCommit** | **_@variable.builtin_** | commit ref | | **LazyCommit** | ***@variable.builtin*** | commit ref |
| **LazyCommitIssue** | **_Number_** | | | **LazyCommitIssue** | ***Number*** | |
| **LazyCommitScope** | **_Italic_** | conventional commit scope | | **LazyCommitScope** | ***Italic*** | conventional commit scope |
| **LazyCommitType** | **_Title_** | conventional commit type | | **LazyCommitType** | ***Title*** | conventional commit type |
| **LazyDimmed** | **_Conceal_** | property | | **LazyDimmed** | ***Conceal*** | property |
| **LazyDir** | **_@markup.link_** | directory | | **LazyDir** | ***@markup.link*** | directory |
| **LazyH1** | **_IncSearch_** | home button | | **LazyH1** | ***IncSearch*** | home button |
| **LazyH2** | **_Bold_** | titles | | **LazyH2** | ***Bold*** | titles |
| **LazyLocal** | **_Constant_** | | | **LazyLocal** | ***Constant*** | |
| **LazyNoCond** | **_DiagnosticWarn_** | unloaded icon for a plugin where `cond()` was false | | **LazyNoCond** | ***DiagnosticWarn*** | unloaded icon for a plugin where `cond()` was false |
| **LazyNormal** | **_NormalFloat_** | | | **LazyNormal** | ***NormalFloat*** | |
| **LazyProgressDone** | **_Constant_** | progress bar done | | **LazyProgressDone** | ***Constant*** | progress bar done |
| **LazyProgressTodo** | **_LineNr_** | progress bar todo | | **LazyProgressTodo** | ***LineNr*** | progress bar todo |
| **LazyProp** | **_Conceal_** | property | | **LazyProp** | ***Conceal*** | property |
| **LazyReasonCmd** | **_Operator_** | | | **LazyReasonCmd** | ***Operator*** | |
| **LazyReasonEvent** | **_Constant_** | | | **LazyReasonEvent** | ***Constant*** | |
| **LazyReasonFt** | **_Character_** | | | **LazyReasonFt** | ***Character*** | |
| **LazyReasonImport** | **_Identifier_** | | | **LazyReasonImport** | ***Identifier*** | |
| **LazyReasonKeys** | **_Statement_** | | | **LazyReasonKeys** | ***Statement*** | |
| **LazyReasonPlugin** | **_Special_** | | | **LazyReasonPlugin** | ***Special*** | |
| **LazyReasonRequire** | **_@variable.parameter_** | | | **LazyReasonRequire** | ***@variable.parameter*** | |
| **LazyReasonRuntime** | **_@macro_** | | | **LazyReasonRuntime** | ***@macro*** | |
| **LazyReasonSource** | **_Character_** | | | **LazyReasonSource** | ***Character*** | |
| **LazyReasonStart** | **_@variable.member_** | | | **LazyReasonStart** | ***@variable.member*** | |
| **LazySpecial** | **_@punctuation.special_** | | | **LazySpecial** | ***@punctuation.special*** | |
| **LazyTaskError** | **_ErrorMsg_** | task errors | | **LazyTaskError** | ***ErrorMsg*** | task errors |
| **LazyTaskOutput** | **_MsgArea_** | task output | | **LazyTaskOutput** | ***MsgArea*** | task output |
| **LazyUrl** | **_@markup.link_** | url | | **LazyUrl** | ***@markup.link*** | url |
| **LazyValue** | **_@string_** | value of a property | | **LazyValue** | ***@string*** | value of a property |
# 🚀 Usage # 🚀 Usage
@ -722,7 +722,7 @@ can be enabled with `config.checker.enabled = true`.
Any operation can be started from the UI, with a sub command or an API function: Any operation can be started from the UI, with a sub command or an API function:
| Command | Lua | Description | | Command | Lua | Description |
| ------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | --- | --- | --- |
| `:Lazy build {plugins}` | `require("lazy").build(opts)` | Rebuild a plugin | | `:Lazy build {plugins}` | `require("lazy").build(opts)` | Rebuild a plugin |
| `:Lazy check [plugins]` | `require("lazy").check(opts?)` | Check for updates and show the log (git fetch) | | `:Lazy check [plugins]` | `require("lazy").check(opts?)` | Check for updates and show the log (git fetch) |
| `:Lazy clean [plugins]` | `require("lazy").clean(opts?)` | Clean plugins that are no longer needed | | `:Lazy clean [plugins]` | `require("lazy").clean(opts?)` | Clean plugins that are no longer needed |
@ -970,4 +970,3 @@ or 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 file will be loaded when the plugin is installed or updated.
This makes it easier for users, as they no longer need to specify a `build` command. This makes it easier for users, as they no longer need to specify a `build` command.

96
doc/lazy.nvim.txt
View File

@ -7,6 +7,8 @@ Table of Contents *lazy.nvim-table-of-contents*
- ✨ Features |lazy.nvim-🚀-getting-started-✨-features| - ✨ Features |lazy.nvim-🚀-getting-started-✨-features|
- ⚡️ Requirements |lazy.nvim-🚀-getting-started-⚡️-requirements| - ⚡️ Requirements |lazy.nvim-🚀-getting-started-⚡️-requirements|
2. 🛠️ Installation |lazy.nvim-🛠️-installation| 2. 🛠️ Installation |lazy.nvim-🛠️-installation|
- Structured Setup |lazy.nvim-🛠️-installation-structured-setup|
- Single File Setup |lazy.nvim-🛠️-installation-single-file-setup|
3. 🔌 Plugin Spec |lazy.nvim-🔌-plugin-spec| 3. 🔌 Plugin Spec |lazy.nvim-🔌-plugin-spec|
- Source |lazy.nvim-🔌-plugin-spec-source| - Source |lazy.nvim-🔌-plugin-spec-source|
- Loading |lazy.nvim-🔌-plugin-spec-loading| - Loading |lazy.nvim-🔌-plugin-spec-loading|
@ -90,59 +92,52 @@ all available options.
STRUCTURED SETUP *lazy.nvim-🛠️-installation-structured-setup*
`lua title="~/.config/nvim/init.lua" require("config.lazy")` >lua
require("config.lazy")
>
<!-- install_multi:start -->
< <
```lua title="~/.config/nvim/lua/config/lazy.lua" – Bootstrap lazy.nvim local >lua
lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" if not (vim.uv or -- Bootstrap lazy.nvim
vim.loop).fs_stat(lazypath) then local lazyrepo = local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
"https://github.com/folke/lazy.nvim.git" vim.fn.system({ "git", "clone", if not (vim.uv or vim.loop).fs_stat(lazypath) then
"–filter=blob:none", "–branch=stable", lazyrepo, lazypath }) end local lazyrepo = "https://github.com/folke/lazy.nvim.git"
vim.opt.rtp:prepend(lazypath) vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
end
vim.opt.rtp:prepend(lazypath)
– Make sure to setup `mapleader` and `maplocalleader` before – loading -- Make sure to setup `mapleader` and `maplocalleader` before
lazy.nvim so that mappings are correct. – This is also a good place to setup -- loading lazy.nvim so that mappings are correct.
other settings (vim.opt) vim.g.mapleader = ” ” vim.g.maplocalleader = "\" -- This is also a good place to setup other settings (vim.opt)
vim.g.mapleader = " "
vim.g.maplocalleader = "\\"
– Setup lazy.nvim require("lazy").setup({ – highlight-start spec = { – -- Setup lazy.nvim
import your plugins { import = "plugins" }, }, – highlight-end – Configure require("lazy").setup({
any other settings here. See the documentation for more details. – -- highlight-start
colorscheme that will be used when installing plugins. install = { colorscheme spec = {
= { "habamax" } }, – automatically check for plugin updates checker = { -- import your plugins
enabled = true }, }) { import = "plugins" },
},
-- highlight-end
-- Configure any other settings here. See the documentation for more details.
-- colorscheme that will be used when installing plugins.
install = { colorscheme = { "habamax" } },
-- automatically check for plugin updates
checker = { enabled = true },
})
<
> You can then create your plugin specs in `~/.config/nvim/lua/plugins/`. Each
file should return a table with the plugins you want to install.
<!-- install_multi:end --> For more info see Structuring Your Plugins </usage/structuring>
You can then create your plugin specs in `~/.config/nvim/lua/plugins/`.
Each file should return a table with the plugins you want to install.
For more info see [Structuring Your Plugins](/usage/structuring) SINGLE FILE SETUP *lazy.nvim-🛠️-installation-single-file-setup*
<!-- prettier-ignore-start --> >lua
<pre>
~/.config/nvim
├── lua
│   ├── config
│   │   └── lazy.lua
│   └── plugins
│   ├── spec1.lua
│   ├── **
│   └── spec2.lua
└── init.lua
</pre>
<!-- prettier-ignore-end -->
</TabItem>
<TabItem value="single" label="Single File Setup">
<!-- install_single:start -->
```lua title="~/.config/nvim/init.lua"
-- Bootstrap lazy.nvim -- Bootstrap lazy.nvim
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then if not (vim.uv or vim.loop).fs_stat(lazypath) then
@ -173,8 +168,6 @@ enabled = true }, })
< <
============================================================================== ==============================================================================
3. 🔌 Plugin Spec *lazy.nvim-🔌-plugin-spec* 3. 🔌 Plugin Spec *lazy.nvim-🔌-plugin-spec*
@ -550,8 +543,13 @@ will be added to the plugin’s spec.
{ {
root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
defaults = { defaults = {
-- By default, only LazyVim plugins will be lazy-loaded. Your custom plugins will load during startup.
-- If you know what you're doing, you can set this to `true` to have all your custom plugins lazy-loaded by default.
lazy = false, -- should plugins be lazy-loaded? lazy = false, -- should plugins be lazy-loaded?
version = nil, -- It's recommended to leave version=false for now, since a lot the plugin that support versioning,
-- have outdated releases, which may break your Neovim install.
version = nil, -- always use the latest git commit
-- version = "*", -- try installing the latest stable version for plugins that support semver
-- default `cond` you can use to globally disable a lot of plugins -- default `cond` you can use to globally disable a lot of plugins
-- when running inside vscode for example -- when running inside vscode for example
cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil
@ -1185,11 +1183,11 @@ command.
============================================================================== ==============================================================================
16. Links *lazy.nvim-links* 16. Links *lazy.nvim-links*
1. *image*: docs/https:/user-images.githubusercontent.com/292349/208301737-68fb279c-ba70-43ef-a369-8c3e8367d6b1.png 1. *image*: https://user-images.githubusercontent.com/292349/208301737-68fb279c-ba70-43ef-a369-8c3e8367d6b1.png
2. *@theme/Tabs*: 2. *@theme/Tabs*:
3. *@theme/TabItem*: 3. *@theme/TabItem*:
4. *image*: docs/usage/https:/user-images.githubusercontent.com/292349/208301766-5c400561-83c3-4811-9667-1ec4bb3c43b8.png 4. *image*: https://user-images.githubusercontent.com/292349/208301766-5c400561-83c3-4811-9667-1ec4bb3c43b8.png
5. *image*: docs/usage/https:/user-images.githubusercontent.com/292349/208301790-7eedbfa5-d202-4e70-852e-de68aa47233b.png 5. *image*: https://user-images.githubusercontent.com/292349/208301790-7eedbfa5-d202-4e70-852e-de68aa47233b.png
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

7
docs/configuration/index.md
View File

@ -11,13 +11,8 @@ sidebar_position: 5
{ {
root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
defaults = { defaults = {
-- By default, only LazyVim plugins will be lazy-loaded. Your custom plugins will load during startup.
-- If you know what you're doing, you can set this to `true` to have all your custom plugins lazy-loaded by default.
lazy = false, -- should plugins be lazy-loaded? lazy = false, -- should plugins be lazy-loaded?
-- It's recommended to leave version=false for now, since a lot the plugin that support versioning, version = nil,
-- have outdated releases, which may break your Neovim install.
version = nil, -- always use the latest git commit
-- version = "*", -- try installing the latest stable version for plugins that support semver
-- default `cond` you can use to globally disable a lot of plugins -- default `cond` you can use to globally disable a lot of plugins
-- when running inside vscode for example -- when running inside vscode for example
cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil