Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-13 22:47:59 +08:00
Code Issues Projects Releases Wiki Activity

docs(nvim-plug): update readme

Browse Source
This commit is contained in:
Eric Wong 2025-02-06 12:15:56 +08:00
parent 8f4f3dda60
commit 5d7b6aa055
No known key found for this signature in database
GPG Key ID: 41BB7053E835C848
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
bundle/nvim-plug/README.md vendored
View File

@ -62,7 +62,8 @@ require('plug').add({
## Custom Plugin UI
The default is ui is inspired by [vundle](https://github.com/VundleVim/Vundle.vim), to setup cutom ui, you need to creat a on_update function, this function is called with two arges:
The default is ui is inspired by [vundle](https://github.com/VundleVim/Vundle.vim), to setup custom UI,
you need to creat a on_update function, this function is called with two arges:
- name: `string`
- date: `PlugUiData`
@ -71,6 +72,24 @@ The default is ui is inspired by [vundle](https://github.com/VundleVim/Vundle.vi
| ------------ | ---------------------------------------- |
| `clone_done` | boolead, is true when clone successfully |
```lua
--- your custom UI
local function on_ui_update(name, data)
-- logic
end
require('plug').setup({
bundle_dir = 'D:/bundle_dir',
max_processes = 5, -- max number of processes used for nvim-plug job
base_url = 'https://github.com',
ui = on_ui_update, -- default ui is notify, use `default` for split window UI
})
```
## Feedback
The development of this plugin is in [`SpaceVim/bundle/nvim-plug`](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/nvim-plug) directory.