Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-04-15 08:09:11 +08:00
Code Issues Projects Releases Wiki Activity

docs(website): update custom_plugins document

Browse Source
This commit is contained in:
Shidong Wang 2021-11-12 09:54:11 +08:00
parent 362485ea23
commit 52c76a1147
No known key found for this signature in database
GPG Key ID: 41BB7053E835C848
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/documentation.md
View File

@ -273,9 +273,22 @@ to the `custom_plugins` section:
```toml
[[custom_plugins]]
repo = "lilydjwg/colorizer"
on_cmd = ["ColorHighlight", "ColorToggle"]
repo = 'lilydjwg/colorizer'
# `on_cmd` option means this plugin will be loaded
# only when the specific commands are called.
# for example, when `:ColorHighlight` or `:ColorToggle`
# commands are called.
on_cmd = ['ColorHighlight', 'ColorToggle']
# `on_func` option means this plugin will be loaded
# only when the specific functions are called.
# for example, when `colorizer#ColorToggle()` function is called.
on_func = 'colorizer#ColorToggle'
# `merged` option is used for merging plugins directory.
# When `merged` is `true`, all files in this custom plugin
# will be merged into `~/.cache/vimfiles/.cache/init.vim/`
# for neovim or `~/.cache/vimfiles/.cache/vimrc/` for vim.
merged = false
# For more options see `:h dein-options`.
```
You can also use the url of the repository, for example:
@ -286,14 +299,6 @@ You can also use the url of the repository, for example:
merged = false
```
`on_cmd` option means this plugin will be loaded only when the following commands are called.
`merged` option is used for merging plugins directory. When `merged` is `true`, all files in
this custom plugin will be merged into `~/.cache/vimfiles/.cache/init.vim/` for neovim or
`~/.cache/vimfiles/.cache/vimrc/` for vim.
For more options see `:h dein-options`.
**disable existing plugins**
If you want to disable plugins which are added by SpaceVim,