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

minor cleanup of documentation.

Browse Source
This commit is contained in:
Bailey Ling 2013-09-07 01:52:53 +00:00
parent 22f1701a2e
commit bfb091c3ca
3 changed files with 15 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -23,18 +23,20 @@ If you don't like the defaults, you can replace all sections with standard `stat
## Automatic truncation
Sections are automatically hidden when the window size shrinks.
Sections and parts within sections can be configured to automatically hide when the window size shrinks.
![image](https://f.cloud.github.com/assets/306502/1060831/05c08aac-11bc-11e3-8470-a506a3037f45.png)
## Smarter tab line
Automatically displays all buffers when there's only one tab open. This is disabled by default; add the following to your vimrc to enable the extension:
let g:airline#extensions#tabline#enabled = 1
Automatically displays all buffers when there's only one tab open.
![tabline](https://f.cloud.github.com/assets/306502/1072623/44c292a0-1495-11e3-9ce6-dcada3f1c536.gif)
This is disabled by default; add the following to your vimrc to enable the extension:
let g:airline#extensions#tabline#enabled = 1
## Seamless integration
vim-airline integrates with a variety of plugins out of the box. These extensions will be lazily loaded if and only if you have the other plugins installed (and of course you can turn them off).
@ -90,7 +92,6 @@ There's already [powerline][2], why yet another statusline?
What about [vim-powerline][1]?
* vim-powerline has been deprecated in favor of the newer, unifying powerline, which is under active development; the new version is written in python and expands its capabilities to tools outside of vim, such as bash, zsh, and tmux.
* 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?
@ -119,7 +120,7 @@ This plugin follows the standard runtime path structure, and as such it can be i
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][20]. Prepatched fonts can be found in the [powerline-fonts][3] repository.
Finally, enable them in vim-airline by adding `let g:airline_powerline_fonts = 1` to your vimrc.
Finally, you can add the convenience variable `let g:airline_powerline_fonts = 1` to your vimrc which will automatically populate the `g:airline_symbols` dictionary with the powerline symbols.
# FAQ

1
autoload/airline/deprecation.vim
View File

@ -19,7 +19,6 @@ function! airline#deprecation#check()
\ [ 'g:airline_enable_branch', 'g:airline#extensions#branch#enabled' ],
\ [ 'g:airline_enable_bufferline', 'g:airline#extensions#bufferline#enabled' ],
\ [ 'g:airline_enable_syntastic', 'g:airline#extensions#syntastic#enabled' ],
\ [ 'g:airline#extensions#tabline#fnamemod', 'g:airline#extensions#tabline#formatter' ],
\ ]
for test in tests
if exists(test[0])

20
doc/airline.txt
View File

@ -321,21 +321,17 @@ virtualenv <https://github.com/jmcantrell/vim-virtualenv>
endfunction
let g:airline#extensions#tabline#formatter = 'foo'
<
* configure whether buffer numbers should be shown. >
let g:airline#extensions#tabline#buffer_nr_show = 0
<
Note: this is only used by the 'default' formatter.
Note: the following variables are only used by the 'default' formatter.
* configure how buffer numbers should be formatted with |printf|. >
let g:airline#extensions#tabline#buffer_nr_format = '%s: '
* configure whether buffer numbers should be shown. >
let g:airline#extensions#tabline#buffer_nr_show = 0
<
Note: this is only used by the 'default' formatter.
* configure the formatting of filenames (see |filename-modifiers|). >
let g:airline#extensions#tabline#fnamemod = ':p:.'
* configure how buffer numbers should be formatted with |printf|. >
let g:airline#extensions#tabline#buffer_nr_format = '%s: '
<
* configure the formatting of filenames (see |filename-modifiers|). >
let g:airline#extensions#tabline#fnamemod = ':p:.'
<
Note: this is only used by the 'default' formatter.
* configure the minimum number of buffers needed to show the tabline. >
let g:airline#extensions#tabline#buffer_min_count = 0
<