From c7a0df45d5e10bd007bede755b0aaf8c9d4dfdf5 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Sun, 23 Jun 2024 17:49:33 +0000
Subject: [PATCH] chore(build): auto-generate docs
---
README.md | 105 ++++++++++++++++++------------------
doc/lazy.nvim.txt | 104 ++++++++++++++++++-----------------
docs/configuration/index.md | 7 +--
3 files changed, 104 insertions(+), 112 deletions(-)
diff --git a/README.md b/README.md
index fa5c41c..270d50e 100644
--- a/README.md
+++ b/README.md
@@ -655,40 +655,40 @@ with a lazy extension in `lazy`.
# π Highlight Groups
-| Highlight Group | Default Group | Description |
-| --------------------- | -------------------------- | --------------------------------------------------- |
-| **LazyButton** | **_CursorLine_** | |
-| **LazyButtonActive** | **_Visual_** | |
-| **LazyComment** | **_Comment_** | |
-| **LazyCommit** | **_@variable.builtin_** | commit ref |
-| **LazyCommitIssue** | **_Number_** | |
-| **LazyCommitScope** | **_Italic_** | conventional commit scope |
-| **LazyCommitType** | **_Title_** | conventional commit type |
-| **LazyDimmed** | **_Conceal_** | property |
-| **LazyDir** | **_@markup.link_** | directory |
-| **LazyH1** | **_IncSearch_** | home button |
-| **LazyH2** | **_Bold_** | titles |
-| **LazyLocal** | **_Constant_** | |
-| **LazyNoCond** | **_DiagnosticWarn_** | unloaded icon for a plugin where `cond()` was false |
-| **LazyNormal** | **_NormalFloat_** | |
-| **LazyProgressDone** | **_Constant_** | progress bar done |
-| **LazyProgressTodo** | **_LineNr_** | progress bar todo |
-| **LazyProp** | **_Conceal_** | property |
-| **LazyReasonCmd** | **_Operator_** | |
-| **LazyReasonEvent** | **_Constant_** | |
-| **LazyReasonFt** | **_Character_** | |
-| **LazyReasonImport** | **_Identifier_** | |
-| **LazyReasonKeys** | **_Statement_** | |
-| **LazyReasonPlugin** | **_Special_** | |
-| **LazyReasonRequire** | **_@variable.parameter_** | |
-| **LazyReasonRuntime** | **_@macro_** | |
-| **LazyReasonSource** | **_Character_** | |
-| **LazyReasonStart** | **_@variable.member_** | |
-| **LazySpecial** | **_@punctuation.special_** | |
-| **LazyTaskError** | **_ErrorMsg_** | task errors |
-| **LazyTaskOutput** | **_MsgArea_** | task output |
-| **LazyUrl** | **_@markup.link_** | url |
-| **LazyValue** | **_@string_** | value of a property |
+| Highlight Group | Default Group | Description |
+| --- | --- | --- |
+| **LazyButton** | ***CursorLine*** | |
+| **LazyButtonActive** | ***Visual*** | |
+| **LazyComment** | ***Comment*** | |
+| **LazyCommit** | ***@variable.builtin*** | commit ref |
+| **LazyCommitIssue** | ***Number*** | |
+| **LazyCommitScope** | ***Italic*** | conventional commit scope |
+| **LazyCommitType** | ***Title*** | conventional commit type |
+| **LazyDimmed** | ***Conceal*** | property |
+| **LazyDir** | ***@markup.link*** | directory |
+| **LazyH1** | ***IncSearch*** | home button |
+| **LazyH2** | ***Bold*** | titles |
+| **LazyLocal** | ***Constant*** | |
+| **LazyNoCond** | ***DiagnosticWarn*** | unloaded icon for a plugin where `cond()` was false |
+| **LazyNormal** | ***NormalFloat*** | |
+| **LazyProgressDone** | ***Constant*** | progress bar done |
+| **LazyProgressTodo** | ***LineNr*** | progress bar todo |
+| **LazyProp** | ***Conceal*** | property |
+| **LazyReasonCmd** | ***Operator*** | |
+| **LazyReasonEvent** | ***Constant*** | |
+| **LazyReasonFt** | ***Character*** | |
+| **LazyReasonImport** | ***Identifier*** | |
+| **LazyReasonKeys** | ***Statement*** | |
+| **LazyReasonPlugin** | ***Special*** | |
+| **LazyReasonRequire** | ***@variable.parameter*** | |
+| **LazyReasonRuntime** | ***@macro*** | |
+| **LazyReasonSource** | ***Character*** | |
+| **LazyReasonStart** | ***@variable.member*** | |
+| **LazySpecial** | ***@punctuation.special*** | |
+| **LazyTaskError** | ***ErrorMsg*** | task errors |
+| **LazyTaskOutput** | ***MsgArea*** | task output |
+| **LazyUrl** | ***@markup.link*** | url |
+| **LazyValue** | ***@string*** | value of a property |
# π Usage
@@ -721,24 +721,24 @@ can be enabled with `config.checker.enabled = true`.
Any operation can be started from the UI, with a sub command or an API function:
-| Command | Lua | Description |
-| ------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `: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 clean [plugins]` | `require("lazy").clean(opts?)` | Clean plugins that are no longer needed |
-| `:Lazy clear` | `require("lazy").clear()` | Clear finished tasks |
-| `:Lazy debug` | `require("lazy").debug()` | Show debug information |
-| `:Lazy health` | `require("lazy").health()` | Run `:checkhealth lazy` |
-| `:Lazy help` | `require("lazy").help()` | Toggle this help page |
-| `:Lazy home` | `require("lazy").home()` | Go back to plugin list |
-| `:Lazy install [plugins]` | `require("lazy").install(opts?)` | Install missing plugins |
-| `:Lazy load {plugins}` | `require("lazy").load(opts)` | Load a plugin that has not been loaded yet. Similar to `:packadd`. Like `:Lazy load foo.nvim`. Use `:Lazy! load` to skip `cond` checks. |
-| `:Lazy log [plugins]` | `require("lazy").log(opts?)` | Show recent updates |
-| `:Lazy profile` | `require("lazy").profile()` | Show detailed profiling |
-| `:Lazy reload {plugins}` | `require("lazy").reload(opts)` | Reload a plugin (experimental!!) |
+| Command | Lua | Description |
+| --- | --- | --- |
+| `: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 clean [plugins]` | `require("lazy").clean(opts?)` | Clean plugins that are no longer needed |
+| `:Lazy clear` | `require("lazy").clear()` | Clear finished tasks |
+| `:Lazy debug` | `require("lazy").debug()` | Show debug information |
+| `:Lazy health` | `require("lazy").health()` | Run `:checkhealth lazy` |
+| `:Lazy help` | `require("lazy").help()` | Toggle this help page |
+| `:Lazy home` | `require("lazy").home()` | Go back to plugin list |
+| `:Lazy install [plugins]` | `require("lazy").install(opts?)` | Install missing plugins |
+| `:Lazy load {plugins}` | `require("lazy").load(opts)` | Load a plugin that has not been loaded yet. Similar to `:packadd`. Like `:Lazy load foo.nvim`. Use `:Lazy! load` to skip `cond` checks. |
+| `:Lazy log [plugins]` | `require("lazy").log(opts?)` | Show recent updates |
+| `:Lazy profile` | `require("lazy").profile()` | Show detailed profiling |
+| `:Lazy reload {plugins}` | `require("lazy").reload(opts)` | Reload a plugin (experimental!!) |
| `:Lazy restore [plugins]` | `require("lazy").restore(opts?)` | Updates all plugins to the state in the lockfile. For a single plugin: restore it to the state in the lockfile or to a given commit under the cursor |
-| `:Lazy sync [plugins]` | `require("lazy").sync(opts?)` | Run install, clean and update |
-| `:Lazy update [plugins]` | `require("lazy").update(opts?)` | Update plugins. This will also update the lockfile |
+| `:Lazy sync [plugins]` | `require("lazy").sync(opts?)` | Run install, clean and update |
+| `:Lazy update [plugins]` | `require("lazy").update(opts?)` | Update plugins. This will also update the lockfile |
Any command can have a **bang** to make the command wait till it finished. For example,
if you want to sync lazy from the cmdline, you can use:
@@ -969,5 +969,4 @@ If your plugin needs a build step, you can specify this in your **package file**
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 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.
\ No newline at end of file
diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt
index 5d28853..c285841 100644
--- a/doc/lazy.nvim.txt
+++ b/doc/lazy.nvim.txt
@@ -7,6 +7,8 @@ Table of Contents *lazy.nvim-table-of-contents*
- β¨ Features |lazy.nvim-π-getting-started-β¨-features|
- β‘οΈ Requirements |lazy.nvim-π-getting-started-β‘οΈ-requirements|
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|
- Source |lazy.nvim-π-plugin-spec-source|
- 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")`
-
->
- <!-- install_multi:start -->
+>lua
+ require("config.lazy")
<
-```lua title="~/.config/nvim/lua/config/lazy.lua" β Bootstrap lazy.nvim local
-lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" if not (vim.uv or
-vim.loop).fs_stat(lazypath) then local lazyrepo =
-"https://github.com/folke/lazy.nvim.git" vim.fn.system({ "git", "clone",
-"βfilter=blob:none", "βbranch=stable", lazyrepo, lazypath }) end
-vim.opt.rtp:prepend(lazypath)
+>lua
+ -- Bootstrap lazy.nvim
+ local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
+ if not (vim.uv or vim.loop).fs_stat(lazypath) then
+ local lazyrepo = "https://github.com/folke/lazy.nvim.git"
+ 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 lazy.nvim so that mappings are correct.
+ -- 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 = {
+ -- import your plugins
+ { 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 },
+ })
+<
-β Make sure to setup `mapleader` and `maplocalleader` before β loading
-lazy.nvim so that mappings are correct. β This is also a good place to setup
-other settings (vim.opt) vim.g.mapleader = β β vim.g.maplocalleader = "\"
+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.
-β Setup lazy.nvim require("lazy").setup({ β highlight-start spec = { β
-import your plugins { 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 }, })
+For more info see Structuring Your Plugins </usage/structuring>
->
-
- <!-- install_multi:end -->
-
- 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)
-
- <!-- prettier-ignore-start -->
- <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"
+
+SINGLE FILE SETUP *lazy.nvim-π οΈ-installation-single-file-setup*
+
+>lua
-- Bootstrap lazy.nvim
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
@@ -173,8 +168,6 @@ enabled = true }, })
<
-
-
==============================================================================
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
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?
- 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
-- when running inside vscode for example
cond = nil, ---@type boolean|fun(self:LazyPlugin):boolean|nil
@@ -1185,11 +1183,11 @@ command.
==============================================================================
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*:
3. *@theme/TabItem*:
-4. *image*: docs/usage/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
+4. *image*: https://user-images.githubusercontent.com/292349/208301766-5c400561-83c3-4811-9667-1ec4bb3c43b8.png
+5. *image*: https://user-images.githubusercontent.com/292349/208301790-7eedbfa5-d202-4e70-852e-de68aa47233b.png
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
diff --git a/docs/configuration/index.md b/docs/configuration/index.md
index 475669e..56d91ca 100644
--- a/docs/configuration/index.md
+++ b/docs/configuration/index.md
@@ -11,13 +11,8 @@ sidebar_position: 5
{
root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
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?
- -- 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
+ version = nil,
-- 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