Skip to content

Commit d53103f

Browse files
author
Nate Kane
committed
Updated the readme and help file with details about the new customizable size option for indent guides
1 parent f2608db commit d53103f

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Indent Guides is a plugin for visually displaying indent levels in Vim.
77
* Will highlight indent levels with alternating colors.
88
* Full support for gVim and basic support for Terminal Vim.
99
* Seems to work on Windows gVim 7.3 (haven't done any extensive tests though).
10+
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
1011

1112
## Requirements
1213
* Vim 7.2+

doc/indent_guides.txt

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010

1111
Author: Nate Kane <nathanaelkane AT gmail DOT com>
12-
Version: 1.1
13-
Last Change: 29 Dec 2010
12+
Version: 1.2
13+
Last Change: 5 Jan 2011
1414

1515
==============================================================================
1616
CONTENTS *indent-guides-contents*
@@ -39,6 +39,7 @@ Features:~
3939
* Full support for gVim and basic support for Terminal Vim.
4040
* Seems to work on Windows gVim 7.3 (haven't done any extensive tests
4141
though).
42+
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
4243

4344
==============================================================================
4445
2. COMMANDS *indent-guides-commands*
@@ -63,6 +64,7 @@ Features:~
6364
------------------------------------------------------------------------------
6465
*'indent_guides_indent_levels'*
6566
Use this option to control how many indent levels to display guides for.
67+
6668
Default: 30. Values: integer.
6769
>
6870
let g:indent_guides_indent_levels = 30
@@ -73,6 +75,7 @@ Default: 30. Values: integer.
7375
Use this option to control whether or not the plugin automatically calculates
7476
the highlight colors. Will use the current colorscheme's background color as a
7577
base color.
78+
7679
Default: 1. Values: 0 or 1.
7780
>
7881
let g:indent_guides_auto_colors = 1
@@ -90,11 +93,29 @@ in an autocmd.
9093
*'indent_guides_color_change_percent'*
9194
Use this option to control the percent at which the highlight colors will be
9295
lightened or darkened.
96+
9397
Default: 0.05. Values: between 0 and 1.
9498
>
9599
let g:indent_guides_color_change_percent = 0.05
96100
<
97101

102+
------------------------------------------------------------------------------
103+
*'indent_guides_indent_guide_size'*
104+
Use this option to customize the size of the indent guide. By default the
105+
value is set to 0, which will set the guide size to be the same as the
106+
|shiftwidth|. Setting this value to be larger than the |shiftwidth| is essentially
107+
the same as setting it to 0.
108+
109+
A common use of this setting is to create skinny indent guides, which look
110+
great with a |shiftwidth| of 4 or more.
111+
112+
NOTE: This option only works for soft-tabs (spaces) and not for hard-tabs.
113+
114+
Default: 0. Values: between 0 and |shiftwidth|.
115+
>
116+
let g:indent_guides_indent_guide_size = 1
117+
<
118+
98119
==============================================================================
99120
4. MAPPINGS *indent-guides-mappings*
100121

@@ -172,6 +193,9 @@ Bug reports, feedback, suggestions etc are welcomed.
172193
==============================================================================
173194
7. CHANGELOG *indent-guides-changelog*
174195

196+
1.2~
197+
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
198+
* Refactored some internal logic.
175199
1.1~
176200
* Added basic support for Terminal Vim. See |indent-guides-terminal-vim| for
177201
more information.

0 commit comments

Comments
 (0)