kevin/vim-plug
1
Fork 0
mirror of https://github.com/junegunn/vim-plug.git synced 2024-12-19 18:47:29 -07:00
Code Issues Packages Projects Releases Wiki Activity

Updated api (markdown)

junegunn 2014-10-01 00:34:47 -07:00
parent 91c0b0abe5
commit af9a65dea7
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
api.md

@ -1,17 +1,17 @@
## API
### Functions
| Function | Description |
| -------- | ----------- |
| `plug#begin(path)` | Start vim-plug block |
| `plug#end()` | End block, update &rtp, and load plugins when not `vim_starting` |
| `plug#helptags()` | Regenerate help tags for all plugins |
| `plug#load(names...)` | Load the plugins immediately |
### Global variables
| Variable | Type | Description |
| -------- | ---- | ----------- |
| `g:plug_home` | String | Directory to store/load plugins. Set by `plug#begin(path)` call. |
## API
### Functions
| Function | Description |
| -------- | ----------- |
| `plug#begin(path)` | Start vim-plug block |
| `plug#end()` | End block, update &rtp, and load plugins when not `vim_starting` |
| `plug#helptags()` | Regenerate help tags for all plugins |
| `plug#load(names...)` | Load the plugins immediately |
### Global variables (read-only)
| Variable | Type | Description |
| -------- | ---- | ----------- |
| `g:plug_home` | String | Directory to store/load plugins. Set by `plug#begin(path)` call. |
| `g:plugs` | Dict | Information of plugins. Initialized by `plug#begin(path)` and incrementally set by `Plug` commands. |