mirror of https://github.com/folke/lazy.nvim.git
chore(build): auto-generate vimdoc
This commit is contained in:
parent
4392a58c22
commit
136776744b
|
@ -7,6 +7,8 @@ Table of Contents *lazy.nvim-table-of-contents*
|
||||||
- Features |lazy.nvim-features|
|
- Features |lazy.nvim-features|
|
||||||
- Requirements |lazy.nvim-requirements|
|
- Requirements |lazy.nvim-requirements|
|
||||||
- Installation |lazy.nvim-installation|
|
- Installation |lazy.nvim-installation|
|
||||||
|
- Usage |lazy.nvim-usage|
|
||||||
|
- Configuration |lazy.nvim-configuration|
|
||||||
- Profiler |lazy.nvim-profiler|
|
- Profiler |lazy.nvim-profiler|
|
||||||
- Debug |lazy.nvim-debug|
|
- Debug |lazy.nvim-debug|
|
||||||
- Differences with Packer |lazy.nvim-differences-with-packer|
|
- Differences with Packer |lazy.nvim-differences-with-packer|
|
||||||
|
@ -69,6 +71,110 @@ You can use the following Lua code to bootstrap **lazy.nvim**
|
||||||
<
|
<
|
||||||
|
|
||||||
|
|
||||||
|
USAGE *lazy.nvim-usage*
|
||||||
|
|
||||||
|
Add **lazy.nvim** to the top of your `init.lua`
|
||||||
|
|
||||||
|
>
|
||||||
|
-- You can use a lua module that contains your plugins.
|
||||||
|
-- All sub modules of the lua module will also be automatically loaded
|
||||||
|
-- This is the preferred setup so your plugin specs can be properly cached.
|
||||||
|
require("lazy").setup("config.plugins", {
|
||||||
|
-- add any optional configuration options here
|
||||||
|
})
|
||||||
|
|
||||||
|
-- Alternatively you can specify a plugin list
|
||||||
|
require("lazy").setup({
|
||||||
|
"folke/neodev.nvim",
|
||||||
|
"folke/which-key.nvim",
|
||||||
|
{ "folke/neoconf.nvim", cmd = "Neoconf" },
|
||||||
|
}, {
|
||||||
|
-- add any optional configuration options here
|
||||||
|
})
|
||||||
|
<
|
||||||
|
|
||||||
|
|
||||||
|
CONFIGURATION *lazy.nvim-configuration*
|
||||||
|
|
||||||
|
**lazy.nvim** comes with the following defaults:
|
||||||
|
|
||||||
|
>
|
||||||
|
{
|
||||||
|
root = vim.fn.stdpath("data") .. "/lazy", -- directory where plugins will be installed
|
||||||
|
defaults = {
|
||||||
|
lazy = false, -- should plugins be lazy-loaded?
|
||||||
|
version = nil,
|
||||||
|
-- version = "", -- enable this to try installing the latest stable versions of plugins
|
||||||
|
},
|
||||||
|
lockfile = vim.fn.stdpath("config") .. "/lazy-lock.json", -- lockfile generated after running update.
|
||||||
|
concurrency = nil, ---@type number limit the maximum amount of concurrent tasks
|
||||||
|
git = {
|
||||||
|
-- defaults for the `Lazy log` command
|
||||||
|
-- log = { "-10" }, -- show the last 10 commits
|
||||||
|
log = { "--since=1 days ago" }, -- show commits from the last 3 days
|
||||||
|
timeout = 120, -- kill processes that take more than 2 minutes
|
||||||
|
url_format = "https://github.com/%s.git",
|
||||||
|
},
|
||||||
|
dev = {
|
||||||
|
-- directory where you store your local plugin projects
|
||||||
|
path = vim.fn.expand("~/projects"),
|
||||||
|
---@type string[] plugins that match these patterns will use your local versions instead of being fetched from GitHub
|
||||||
|
patterns = {}, -- For example {"folke"}
|
||||||
|
},
|
||||||
|
install = {
|
||||||
|
-- install missing plugins on startup. This doesn't increase startup time.
|
||||||
|
missing = true,
|
||||||
|
-- try to load one of these colorschemes when starting an installation during startup
|
||||||
|
colorscheme = { "habamax" },
|
||||||
|
},
|
||||||
|
ui = {
|
||||||
|
-- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
|
||||||
|
border = "none",
|
||||||
|
icons = {
|
||||||
|
cmd = " ",
|
||||||
|
config = "",
|
||||||
|
event = "",
|
||||||
|
ft = " ",
|
||||||
|
init = " ",
|
||||||
|
keys = " ",
|
||||||
|
plugin = " ",
|
||||||
|
runtime = " ",
|
||||||
|
source = " ",
|
||||||
|
start = "",
|
||||||
|
task = " ",
|
||||||
|
},
|
||||||
|
throttle = 20, -- how frequently should the ui process render events
|
||||||
|
},
|
||||||
|
checker = {
|
||||||
|
-- automcatilly check for plugin updates
|
||||||
|
enabled = false,
|
||||||
|
concurrency = nil, ---@type number? set to 1 to check for updates very slowly
|
||||||
|
notify = true, -- get a notification when new updates are found
|
||||||
|
frequency = 3600, -- check for updates every hour
|
||||||
|
},
|
||||||
|
performance = {
|
||||||
|
---@type LazyCacheConfig
|
||||||
|
cache = nil,
|
||||||
|
reset_packpath = true, -- reset the package path to improve startup time
|
||||||
|
rtp = {
|
||||||
|
reset = true, -- reset the runtime path to $VIMRUNTIME and your config directory
|
||||||
|
---@type string[] list any plugins you want to disable here
|
||||||
|
disabled_plugins = {
|
||||||
|
-- "gzip",
|
||||||
|
-- "matchit",
|
||||||
|
-- "matchparen",
|
||||||
|
-- "netrwPlugin",
|
||||||
|
-- "tarPlugin",
|
||||||
|
-- "tohtml",
|
||||||
|
-- "tutor",
|
||||||
|
-- "zipPlugin",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
<
|
||||||
|
|
||||||
|
|
||||||
PROFILER *lazy.nvim-profiler*
|
PROFILER *lazy.nvim-profiler*
|
||||||
|
|
||||||
The profiling view shows you why and how long it took to load your plugins.
|
The profiling view shows you why and how long it took to load your plugins.
|
||||||
|
|
Loading…
Reference in New Issue