mirror of
https://github.com/folke/lazy.nvim.git
synced 2025-04-19 21:06:46 +00:00
chore(build): auto-generate docs
This commit is contained in:
github-actions[bot]
parent
f6a98dbd81
commit
c7a0df45d5
3 changed files with 104 additions and 112 deletions
|
|
@ -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>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue