Skip to content

Commit 6f9845e

Browse files
chore(build): auto-generate vimdoc
1 parent 2a7b004 commit 6f9845e

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

doc/lazy.nvim.txt

+15-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ PLUGIN SPEC *lazy.nvim-plugin-spec*
120120
│**enabled** │boolean? or fun():boolean │When false, or if the function returns false, then this plugin will not be used │
121121
│**dependencies**│LazySpec[] │A list of plugin specs that should be loaded when the plugin loads. Dependencies are always lazy-loaded unless specified otherwise │
122122
│**init** │fun(LazyPlugin) │init functions are always executed during startup │
123-
│**config** │fun(LazyPlugin) │config is executed when the plugin loads
123+
│**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)
124124
│**build** │fun(LazyPlugin) │build is executed when a plugin is installed or updated │
125125
│**branch** │string? │Branch of the repository │
126126
│**tag** │string? │Tag of the repository │
@@ -242,6 +242,20 @@ EXAMPLES ~
242242
end,
243243
},
244244

245+
-- the above could also be written as
246+
{
247+
"nvim-neorg/neorg",
248+
ft = "norg",
249+
config = true, -- run require("norg").setup()
250+
},
251+
252+
-- or set custom config
253+
{
254+
"nvim-neorg/neorg",
255+
ft = "norg",
256+
config = { foo = "bar" }, -- run require("norg").setup({foo = "bar"})
257+
},
258+
245259
{
246260
"dstein64/vim-startuptime",
247261
-- lazy-load on a command

0 commit comments

Comments
 (0)