1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-19 09:33:44 +08:00
SpaceVim/bundle/nvim-plug/README.md
2025-02-04 23:57:15 +08:00

52 lines
1.5 KiB
Markdown
Vendored

# nvim-plug
> _nvim-plug_ is a simple plugin manager for neovim
[![](https://spacevim.org/img/build-with-SpaceVim.svg)](https://spacevim.org)
[![GPLv3 License](https://img.spacevim.org/license-GPLv3-blue.svg)](LICENSE)
**Alpha version. Any changes, including backward incompatible changes, are applied without announcements.**
## Usage
```lua
require('plug').setup({
bundle_dir = 'D:/bundle_dir',
})
require('plug').add({
{
'wsdjeg/scrollbar.vim',
events = { 'VimEnter' },
config = function() end,
},
{
'wsdjeg/flygrep.nvim',
cmds = { 'FlyGrep' },
config = function()
require('flygrep').setup()
end,
},
})
```
## Plugin Spec
| name | description |
| -------- | ------------------------------------------------------- |
| `[1]` | `string`, plugin repo short name, `wsdjeg/flygrep.nvim` |
| `cmds` | `table<string>`, commands lazy loading |
| `events` | `table<string>`, events lazy loading |
| `on_ft` | `table<string>`, filetypes lazy loading |
| `type` | `string`, plugin type including `color`, `plugin` |
## Commands
- `:PlugInstall`: install specific plugin
## Feedback
The development of this plugin is in [`SpaceVim/bundle/nvim-plug`](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/nvim-plug) directory.
If you encounter any bugs or have suggestions, please file an issue in the [issue tracker](https://github.com/SpaceVim/SpaceVim/issues)