VimPlug/indentLine
1
0
Fork 0
mirror of https://github.com/Yggdroot/indentLine.git synced 2025-12-07 12:44:27 +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

35
doc/indentLine.txt
View File

@@ -3,16 +3,21 @@
CONTENTS *indentLine-contents* CONTENTS *indentLine-contents*
Introduction |indentLine-introduction| Introduction |indentLine-introduction|
Config |indentLine-config| Config |indentLine-config|
Variables |indentLine-variables|
Commands |indentLine-commands|
FAQ |indentLine-faq| FAQ |indentLine-faq|
Changelog |indentLine-changelog| Changelog |indentLine-changelog|
Credits |indentLine-credits|
============================================================================== ==============================================================================
INTRODUCTION *indentLine-introduction* 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* g:loaded_indentLine *g:loaded_indentLine*
@@ -22,16 +27,17 @@ g:loaded_indentLine *g:loaded_indentLine*
g:indentLine_char *g:indentLine_char* g:indentLine_char *g:indentLine_char*
Specify a character to be used as indent line. Specify a character to be used as indent line.
You also can use other characters: You also can use other characters:
| ¦ ┆ │ | ¦ <20><>?<3F><>?
Default value is "|". Default value is "|".
g:indentLine_color_term *g:indentLine_color_term* g:indentLine_color_term *g:indentLine_color_term*
Specify terminal vim indent line color. Specify terminal vim indent line color.
e.g. let g:indentLine_color_term = 239
g:indentLine_color_gui *g:indentLine_color_gui* g:indentLine_color_gui *g:indentLine_color_gui*
Specify GUI vim indent line color. Specify GUI vim indent line color.
e.g. let g:indentLine_color_gui = '#A4E57E'
g:indentLine_indentLevel *g:indentLine_indentLevel* g:indentLine_indentLevel *g:indentLine_indentLevel*
Specify how much indent level do you want to use for Specify how much indent level do you want to use for
@@ -40,8 +46,25 @@ g:indentLine_indentLevel *g:indentLine_indentLevel*
Default value is 20. Default value is 20.
==============================================================================
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* 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