Updated api (markdown)

Junegunn Choi 2014-08-09 07:56:42 -07:00
parent 419bcd6233
commit 3983985565

11
api.md

@ -1,8 +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 |
| `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. |
| `g:plugs` | Dict | Information of plugins. Initialized by `plug#begin()` and incrementally set by `Plug` commands |