ylib/vim-airline
1
0
Fork 0
mirror of https://github.com/vim-airline/vim-airline.git synced 2024-11-25 09:41:33 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Bailey Ling 2013-08-10 23:22:42 +00:00
parent 384150ecd7
commit 5d92aaecaa
2 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -6,7 +6,7 @@ Lean & mean statusline for vim that's light as air.
# Features
* tiny core (under 200 lines), written with extensibility in mind (specifically adhering to the [open/closed principle][8]).
* tiny core (under 200 lines), written with extensibility in mind ([open/closed principle][8]).
* integrates with a variety of plugins, including: [vim-bufferline][6], [fugitive][4], [unite][9], [ctrlp][10], [minibufexpl][15], [gundo][16], [undotree][17], [nerdtree][18], [tagbar][19], [syntastic][5] and [lawrencium][21].
* 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.

31
doc/airline.txt
View File

@ -1,5 +1,10 @@
*airline.txt* Lean and mean statusline that's light as air
_ _ _ _ ~
__ _(_)_ __ ___ __ _(_)_ __| (_)_ __ ___ ~
\ \ / / | '_ ` _ \ _____ / _` | | '__| | | '_ \ / _ \ ~
\ V /| | | | | | |_____| (_| | | | | | | | | | __/ ~
\_/ |_|_| |_| |_| \__,_|_|_| |_|_|_| |_|\___| ~
~
==============================================================================
INTRODUCTION *airline*
@ -16,8 +21,7 @@ FEATURES *airline-features*
* 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.
* trivial to write colorschemes; for a minimal theme you need to edit
9 lines of colors. (please send pull requests)
* extremely easy to write themes.
==============================================================================
NAME *airline-name*
@ -232,38 +236,41 @@ highlight groups.
TROUBLESHOOTING *airline-troubleshooting*
Q. There are no colors.
A. You need to set up your terminal correctly. For more details, see
<http://vim.wikia.com/wiki/256_colors_in_vim>. Alternatively, if you want to
bypass the automatic detection of terminal colors, you can force Vim into 256
colors with this:
<http://vim.wikia.com/wiki/256_colors_in_vim>. Alternatively, if you want
to bypass the automatic detection of terminal colors, you can force Vim
into 256 color mode with this:
>
set t_Co=256
<
Q. The statusline does not appear until I create a split.
A. This is the default setting of |laststatus|. If you want it to appear all
the time, add the following to your vimrc:
the time, add the following to your vimrc:
>
set laststatus=2
<
Q. Powerline symbols are not showing up.
A. First, you must install patched powerline fonts. Second, you must enable
unicode in vim.
unicode in vim.
>
set encoding=utf-8
<
Q. There is a pause when leaving insert mode.
A. Add the following to your vimrc.
>
set ttimeoutlen=50
<
Q. The colors look a little off for some themes.
A. Certain themes are derived from the active colorscheme by extracting colors
from predefined highlight groups. These airline themes will look good for
their intended matching colorschemes, but will be hit or miss when loaded
with other colorschemes.
Solutions to other common problems can be found in the Wiki:
<https://github.com/bling/vim-airline/wiki/FAQ>