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

update doc

Browse Source
This commit is contained in:
Yggdroot
2012-12-22 23:48:52 +08:00
parent c1ad9925cf
commit 1721492eb8
1 changed files with 54 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
doc/indentLine.txt
View File

@@ -3,45 +3,68 @@
CONTENTS *indentLine-contents*
Introduction |indentLine-introduction|
Config |indentLine-config|
FAQ |indentLine-faq|
Changelog |indentLine-changelog|
Variables |indentLine-variables|
Commands |indentLine-commands|
FAQ |indentLine-faq|
Changelog |indentLine-changelog|
Credits |indentLine-credits|
==============================================================================
INTRODUCTION *indentLine-introduction*
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.
==============================================================================
CONFIG *indentLine-config*
==============================================================================
CONFIG *indentLine-config*
VARIABLES *indentLine-variables*
------------------------------------------------------------------------------
VARIABLES *indentLine-variables*
g:loaded_indentLine *g:loaded_indentLine*
Whether load indentLine plugin.
Default value is 0.
g:loaded_indentLine *g:loaded_indentLine*
Whether load indentLine plugin.
Default value is 0.
g:indentLine_char *g:indentLine_char*
Specify a character to be used as indent line.
You also can use other characters:
| ¦ ┆ │
Default value is "|".
g:indentLine_color_term *g:indentLine_color_term*
Specify terminal vim indent line color.
g:indentLine_color_gui *g:indentLine_color_gui*
Specify GUI vim indent line color.
g:indentLine_indentLevel *g:indentLine_indentLevel*
Specify how much indent level do you want to use for
indentLine. Most program will not has bigger indent level than
20.
Default value is 20.
g:indentLine_char *g:indentLine_char*
Specify a character to be used as indent line.
You also can use other characters:
| ¦ <20><>?<3F><>?
Default value is "|".
g:indentLine_color_term *g:indentLine_color_term*
Specify terminal vim indent line color.
e.g. let g:indentLine_color_term = 239
g:indentLine_color_gui *g:indentLine_color_gui*
Specify GUI vim indent line color.
e.g. let g:indentLine_color_gui = '#A4E57E'
g:indentLine_indentLevel *g:indentLine_indentLevel*
Specify how much indent level do you want to use for
indentLine. Most program will not has bigger indent level than
20.
Default value is 20.
==============================================================================
FAQ *indentLine-faq*
COMMANDS *indentLine-commands*
ResetIndentLines [number]
if 'shiftwidth' changes, using this command can redraw the
indentLines. number is optional, it means the width between
two indent level, if ommited, value of 'shiftwidth' is used.
==============================================================================
FAQ *indentLine-faq*
==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen:fdl=0
CHANGELOG *indentLine-changelog*
==============================================================================
CREDITS *indentLine-credits*
Thanks to the following people for suggestions and patches:
NagatoPain
Salman Halim
==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet