91904d942e | ||
---|---|---|
autoload | ||
doc | ||
plugin | ||
.gitignore | ||
LICENSE | ||
README.md |
README.md
vim-airline
Lean & mean statusline for vim that's light as air.
Features
- tiny core (under 200 lines), written with extensibility in mind (open/closed principle).
- integrates with a variety of plugins, including: vim-bufferline, fugitive, unite, ctrlp, minibufexpl, gundo, undotree, nerdtree, tagbar, syntastic and lawrencium.
- looks good with regular fonts and provides configuration points so you can use unicode or powerline symbols.
- optimized for speed; it loads in under a millisecond.
- fully customizable; if you know a little
statusline
syntax you can tweak it to your needs. - extensive suite of themes for popular colorschemes including solarized (dark and light), tomorrow (all variants), molokai, jellybeans and others; have a look at the screenshots in the wiki.
- supports 7.2 as the minimum Vim version
Extensions/Integration
ctrlp.vim
unite.vim
tagbar
csv.vim
syntastic
whitespace
Rationale
There's already powerline, why yet another statusline?
- 100% vimscript; no python needed.
What about vim-powerline?
- the author has been active developing powerline, which was rewritten in python and expands its capabilities to tools outside of Vim, such as bash, zsh, and tmux.
- vim-powerline has been deprecated as a result, and no features will be added to it.
- vim-powerline uses different font codes, so if you want to use it with a powerline themed tmux (for example), it will not work.
Where did the name come from?
I wrote the initial version on an airplane, and since it's light as air it turned out to be a good name. Thanks for flying vim!
Installation
This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:
- Pathogen
git clone https://github.com/bling/vim-airline ~/.vim/bundle/vim-airline
- NeoBundle
NeoBundle 'bling/vim-airline'
- Vundle
Bundle 'bling/vim-airline'
- VAM
call vam#ActivateAddons([ 'vim-airline' ])
- manual
- copy all of the files into your
~/.vim
directory
Configuration
:help airline
Integrating with powerline fonts
For the nice looking powerline symbols to appear, you will need to install a patched font. Instructions can be found in the official powerline documentation. Prepatched fonts can be found in the powerline-fonts repository.
Finally, enable them in vim-airline by adding let g:airline_powerline_fonts = 1
to your vimrc.
FAQ
Solutions to common problems can be found in the Wiki.
Themes/Screenshots
A full list of screenshots can be found in the Wiki.
Bugs
Tracking down bugs can take a very long time due to different configurations, versions, and operating systems. To ensure a timely response, please help me out by doing the following:
- reproduce it with this minivimrc repository to rule out any configuration conflicts.
- a link to your vimrc or a gist which shows how you configured the plugin(s).
- and so I can reproduce; your
:version
of vim, and the commit of vim-airline you're using.
Contributions
Contributions and pull requests are welcome. Please take note of the following guidelines:
- adhere to the existing style as much as possible; notably, 2 space indents and long-form keywords.
- keep the history clean! squash your branches before you submit a pull request.
pull --rebase
is your friend. - any changes to the core should be tested against Vim 7.2.
- if you submit a theme, please create a screenshot so it can be added to the Wiki.
License
MIT license. Copyright (c) 2013 Bailey Ling.