Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 22, 2022
1 parent 2a7b004 commit 6f9845e
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion doc/lazy.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ PLUGIN SPEC *lazy.nvim-plugin-spec*
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be used │
│**dependencies**│LazySpec[] │A list of plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise │
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
│**config** │fun(LazyPlugin) │config is executed when the plugin loads
│**config** │fun(LazyPlugin) or true or table │config is executed when the plugin loads. You can also set to true or pass a table, that will be passed to require("plugin").setup(opts)
│**build** │fun(LazyPlugin) │build is executed when a plugin is installed or updated │
│**branch** │string? │Branch of the repository │
│**tag** │string? │Tag of the repository │
Expand Down Expand Up @@ -242,6 +242,20 @@ EXAMPLES ~
end,
},

-- the above could also be written as
{
"nvim-neorg/neorg",
ft = "norg",
config = true, -- run require("norg").setup()
},

-- or set custom config
{
"nvim-neorg/neorg",
ft = "norg",
config = { foo = "bar" }, -- run require("norg").setup({foo = "bar"})
},

{
"dstein64/vim-startuptime",
-- lazy-load on a command
Expand Down

0 comments on commit 6f9845e

Please sign in to comment.