mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-14 05:37:57 +08:00
docs(nvim-plug): update readme
This commit is contained in:
parent
8f4f3dda60
commit
5d7b6aa055
21
bundle/nvim-plug/README.md
vendored
21
bundle/nvim-plug/README.md
vendored
@ -62,7 +62,8 @@ require('plug').add({
|
|||||||
|
|
||||||
## Custom Plugin UI
|
## 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`
|
- name: `string`
|
||||||
- date: `PlugUiData`
|
- 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 |
|
| `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
|
## Feedback
|
||||||
|
|
||||||
The development of this plugin is in [`SpaceVim/bundle/nvim-plug`](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/nvim-plug) directory.
|
The development of this plugin is in [`SpaceVim/bundle/nvim-plug`](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/nvim-plug) directory.
|
||||||
|
Loading…
Reference in New Issue
Block a user