vim-plug/README.md

85 lines
2.5 KiB
Markdown
Raw Normal View History

2013-09-10 16:58:41 +02:00
vim-plug
========
2013-09-11 05:06:57 +02:00
A single-file Vim plugin manager.
2013-09-10 16:58:41 +02:00
2013-09-22 17:43:38 +02:00
Somewhere between [Pathogen](https://github.com/tpope/vim-pathogen) and
[Vundle](https://github.com/gmarik/vundle), but with faster parallel installer.
2013-09-18 14:26:15 +02:00
2013-09-24 06:10:57 +02:00
![](https://raw.github.com/junegunn/vim-plug/master/gif/vim-plug.gif)
2013-09-10 17:08:51 +02:00
### Pros.
2013-09-10 16:58:41 +02:00
2013-09-11 05:06:57 +02:00
- Easier to setup
2013-09-22 07:32:06 +02:00
- Parallel installation/update (requires
[+ruby](http://junegunn.kr/2013/09/installing-vim-with-ruby-support/))
2013-09-22 17:43:38 +02:00
- Smallest possible feature set
2013-09-10 16:58:41 +02:00
2013-09-10 17:08:51 +02:00
### Cons.
2013-09-10 16:58:41 +02:00
- Everything else
2013-09-10 16:58:41 +02:00
2013-09-10 17:08:51 +02:00
### Usage
2013-09-10 16:58:41 +02:00
Download plug.vim and put it in ~/.vim/autoload
```sh
mkdir -p ~/.vim/autoload
2013-09-11 05:06:57 +02:00
curl -fLo ~/.vim/autoload/plug.vim https://raw.github.com/junegunn/vim-plug/master/plug.vim
2013-09-10 16:58:41 +02:00
```
Edit your .vimrc
```vim
2013-09-16 10:37:09 +02:00
call plug#begin()
2013-09-10 16:58:41 +02:00
Plug 'junegunn/seoul256'
Plug 'junegunn/vim-easy-align'
" Plug 'user/repo', 'branch_or_tag'
2013-09-17 05:35:10 +02:00
" Plug 'git@github.com:junegunn/vim-github-dashboard.git'
2013-09-10 16:58:41 +02:00
" ...
2013-09-16 10:37:09 +02:00
call plug#end()
2013-09-10 16:58:41 +02:00
```
2013-09-22 18:49:34 +02:00
Then `:PlugInstall` to install plugins.
### Plugin directory
By default, plugins are installed in `plugged` directory under the first path in
runtimepath at the point when `plug#begin()` is called. This is usually
2013-09-22 18:51:55 +02:00
`~/.vim/plugged` (or `$HOME/vimfiles/plugged` on Windows) given that you didn't
touch runtimepath before the call. You can explicitly set the location of the
plugins with `plug#begin(path)` call.
2013-09-10 16:58:41 +02:00
2013-09-10 17:08:51 +02:00
### Commands
2013-09-10 16:58:41 +02:00
2013-09-23 10:33:36 +02:00
| Command | Description |
| ---------------------- | --------------------------- |
| PlugInstall [#threads] | Install plugins |
| PlugUpdate [#threads] | Install or update plugins |
| PlugClean | Remove unused directories |
| PlugUpgrade | Upgrade vim-plug itself |
| PlugStatus | Check the status of plugins |
2013-09-10 17:08:51 +02:00
2013-09-11 05:06:57 +02:00
(Default number of threads = `g:plug_threads` or 16)
2013-09-10 16:58:41 +02:00
2013-09-18 14:26:15 +02:00
### Articles
- [Writing my own Vim plugin manager](http://junegunn.kr/2013/09/writing-my-own-vim-plugin-manager)
2013-09-24 16:15:31 +02:00
### Regarding feature request
You may submit a request for a new feature by [creating an
issue](https://github.com/junegunn/vim-plug/issues). However, please be minded
that this is an opinionated software and I want to keep the feature set as small
as possible. So I may not agree with you on the necessity of the suggested
feature. If that happens, I suggest the following options.
1. Check out [Vundle](https://github.com/gmarik/vundle) or
[NeoBundle](https://github.com/Shougo/neobundle.vim).
They offer broader feature sets.
2. Create a fork of this project and let it be your own plugin manager.
There's no need for us to have a single canonical branch.