From cf5979dd13e656c2e679719e11e863c7fbb53607 Mon Sep 17 00:00:00 2001 From: NagatoPain Date: Thu, 20 Dec 2012 02:02:55 +0800 Subject: [PATCH] add plugin doc file --- README.md | 4 ---- doc/indentLine.txt | 47 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 4 deletions(-) create mode 100644 doc/indentLine.txt diff --git a/README.md b/README.md index 88f3eba..c3e7046 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,6 @@ For vim, hi Conceal ctermfg=(color you like) ctermbg=NONE You can change indentline char by youself. change this variable: -```vim -let g:indentLine_char = "│" -``` - ## Screenshots diff --git a/doc/indentLine.txt b/doc/indentLine.txt new file mode 100644 index 0000000..2c8ea8f --- /dev/null +++ b/doc/indentLine.txt @@ -0,0 +1,47 @@ +*indentLine.txt* Show vertical lines for indent with conceal feature + +CONTENTS *indentLine-contents* +Introduction |indentLine-introduction| +Config |indentLine-config| +FAQ |indentLine-faq| +Changelog |indentLine-changelog| + +============================================================================== +INTRODUCTION *indentLine-introduction* + +============================================================================== +CONFIG *indentLine-config* + +------------------------------------------------------------------------------ +VARIABLES *indentLine-variables* + +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. + Default value is 238. + +g:indentLine_color_gui *g:indentLine_color_gui* + Specify GUI vim indent line color. + Default value is "Grey". + +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 + 10. + Default value is 10. + + +============================================================================== +FAQ *indentLine-faq* + +============================================================================== +vim:tw=78:ts=8:ft=help:norl:noet:fen:fdl=0