From ed6929c6969dc54a60e3005c933b72cf9f5255be Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 14 Dec 2022 23:23:54 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/lazy.nvim.txt | 103 ++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 91 insertions(+), 12 deletions(-) diff --git a/doc/lazy.nvim.txt b/doc/lazy.nvim.txt index 42467f8..074edb3 100644 --- a/doc/lazy.nvim.txt +++ b/doc/lazy.nvim.txt @@ -7,6 +7,7 @@ Table of Contents *lazy.nvim-table-of-contents* - Features |lazy.nvim-features| - Requirements |lazy.nvim-requirements| - Installation |lazy.nvim-installation| + - Plugin Spec |lazy.nvim-plugin-spec| - Configuration |lazy.nvim-configuration| - Usage |lazy.nvim-usage| - Profiler |lazy.nvim-profiler| @@ -55,18 +56,18 @@ INSTALLATION *lazy.nvim-installation* You can use the following Lua code to bootstrap **lazy.nvim** > - local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" - if not vim.loop.fs_stat(lazypath) then - vim.fn.system({ - "git", - "clone", - "--filter=blob:none", - "--single-branch", - "https://github.com/folke/lazy.nvim.git", - lazypath, - }) - vim.opt.runtimepath:prepend(lazypath) - end + local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim" + if not vim.loop.fs_stat(lazypath) then + vim.fn.system({ + "git", + "clone", + "--filter=blob:none", + "--single-branch", + "https://github.com/folke/lazy.nvim.git", + lazypath, + }) + vim.opt.runtimepath:prepend(lazypath) + end < @@ -91,6 +92,84 @@ Next step is to add **lazy.nvim** to the top of your `init.lua` < +PLUGIN SPEC *lazy.nvim-plugin-spec* + +> + return { + -- the colorscheme should be available when starting Neovim + "folke/tokyonight.nvim", + + -- I have a separate config.mappings file where I require which-key. + -- With lazy the plugin will be automatically loaded when it is required somewhere + { "folke/which-key.nvim", lazy = true }, + + { + "nvim-neorg/neorg", + -- lazy-load on filetype + ft = "norg", + -- custom config that will be executed when loading the plugin + config = function() + require("neorg").setup() + end, + }, + + { + "dstein64/vim-startuptime", + -- lazy-load on a command + cmd = "StartupTime", + }, + + { + "hrsh7th/nvim-cmp", + -- load cmp on InsertEnter + event = "InsertEnter", + -- these dependencies will only be loaded when cmp loads + -- dependencies are always lazy-loaded unless specified otherwise + dependencies = { + "hrsh7th/cmp-nvim-lsp", + "hrsh7th/cmp-buffer", + }, + config = function() + -- ... + end, + }, + + -- you can use the VeryLazy event for things that can + -- load later and are not important for the initial UI + { "stevearc/dressing.nvim", event = "VeryLazy" }, + + { + "cshuaimin/ssr.nvim", + -- init is always executed during startup, but doesn't load the plugin yet. + -- init implies lazy loading + init = function() + vim.keymap.set({ "n", "x" }, "cR", function() + -- this require will automatically load the plugin + require("ssr").open() + end, { desc = "Structural Replace" }) + end, + }, + + { + "monaqa/dial.nvim", + -- lazy-load on keys + keys = { "", "" }, + }, + + -- local plugins need to be explicitely configured with dir + { dir = "~/projects/secret.nvim" }, + + -- you can use a custom url to fetch a plugin + { url = "git@github.com:folke/noice.nvim.git" }, + + -- local plugins can also be configure with the dev option. + -- This will use ~/projects/noice.nvim/ instead of fetching it from Github + -- With the dev option, you can easily switch between the local and installed version of a plugin + { "folke/noice.nvim", dev = true }, + } +< + + CONFIGURATION *lazy.nvim-configuration* **lazy.nvim** comes with the following defaults: