VimPlug/indentLine
1
0
Fork 0
mirror of https://github.com/Yggdroot/indentLine.git synced 2025-12-07 20:54:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #23 from padde/master

Browse Source 
Improve Readme
This commit is contained in:
Yggdroot
2013-03-14 18:54:11 -07:00
parent 6655863272 92e1d614e6
commit 7a2708db6f
1 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,32 +1,33 @@
indentLine
==========
This plugin is used for displaying thin vertical lines at each indentation level for code indented with spaces.
For code indented with tabs, I think there is no need to support it, using :set list lcs=tab:\\|\ (here is a space) can
achieve it.
This plugin is used for displaying thin vertical lines at each indentation level for code indented with spaces. For code indented with tabs I think there is no need to support it, because you can use `:set list lcs=tab:\|\ ` (here is a space).
## Requirements
This plugin takes advantage of newly provided conceal feature in Vim 7.3, so Vim 7.3 with conceal feature is needed.
This plugin takes advantage of the newly provided `conceal` feature in Vim 7.3, so this plugin will not work with lower versions of Vim.
## Installation
To install the plugin just put plugin files in your ~/.vim (linux) or ~/vimfiles (Windows).
To install the plugin just put the plugin files in your `~/.vim` (Linux) or `~/vimfiles` (Windows).
## Setting custom indentLines
You can change the color of indentLines:<br/>
for vim, you can set g:indentLine_color_term in your vimrc, e.g. let g:indentLine_color_term = 239(any color you like),<br/>
for gvim, you can set g:indentLine_color_gui in your vimrc, e.g. let g:indentLine_color_gui = '#A4E57E'(any color you like)
If you use a plugin manager you can put the whole directory into your `~/.vim/bundle/` directory ([Pathogen][pathogen]) or add the line `Bundle 'Yggdroot/indentLine'` to your `.vimrc` ([Vundle][vundle]).
You can change indentLine char by youself.<br/>
change this variable: let g:indentLine_char = 'c'; 'c' can be any ascii character you like, you can also use '¦', '┆'and '│' to display more beautiful lines,
but this only aplies to file whose encoding is utf-8
## Customization
You can change the color of indentLines:
for Vim, set `g:indentLine_color_term` in your `.vimrc`, e.g. `let g:indentLine_color_term = 239`,
for GVim, set `g:indentLine_color_gui` in your `.vimrc`, e.g. `let g:indentLine_color_gui = '#A4E57E'`
##Self promotion
If you think this script is helpful, follow the GitHub [repository][repository], and don't forget to vote for it on Vim.org! ([vimscript #4354][script]).
You can also change the indentLine char:
for both Vim and GVim, set `let g:indentLine_char = 'c'` where `'c'` can be any ASCII character. You can also use one of `¦`, `┆` or `│` to display more beautiful lines. However, these characters will only work with files whose encoding is UTF-8.
## Self promotion
If you think this script is helpful, follow the [GitHub repository][repository], and don't forget to vote for it on Vim.org! ([vimscript #4354][script]).
[pathogen]: https://github.com/tpope/vim-pathogen
[vundle]: https://github.com/gmarik/vundle
[repository]: https://github.com/Yggdroot/indentLine
[script]: http://www.vim.org/scripts/script.php?script_id=4354
## Screenshots
<img src="http://i.imgur.com/KVi0T.jpg" width="800" height="600" alt="" />
![Screenshot](http://i.imgur.com/KVi0T.jpg)