vim/vim-indent-guides
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.markdown

Browse Source 
added syntax highlight to make easier to read the options
This commit is contained in:
Matheus Marabesi 2018-05-13 17:19:27 -03:00 committed by GitHub
parent b40687195c
commit 05e4cc018a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
README.markdown
View File

@ -22,63 +22,79 @@ To install the plugin copy `autoload`, `plugin`, `doc` directories into your `.v
### Pathogen ### Pathogen
If you have [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) installed, clone this repo into a subdirectory of your `.vim/bundle` directory like so: If you have [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332) installed, clone this repo into a subdirectory of your `.vim/bundle` directory like so:
cd ~/.vim/bundle ```
git clone git://github.com/nathanaelkane/vim-indent-guides.git cd ~/.vim/bundle
git clone git://github.com/nathanaelkane/vim-indent-guides.git
```
### Vundle ### Vundle
If you have [Vundle](https://github.com/VundleVim/Vundle.vim) installed, add the following line to your `~/.vimrc` in the appropriate spot (see the Vundle.vim README for help): If you have [Vundle](https://github.com/VundleVim/Vundle.vim) installed, add the following line to your `~/.vimrc` in the appropriate spot (see the Vundle.vim README for help):
Plugin 'nathanaelkane/vim-indent-guides' ```vim
Plugin 'nathanaelkane/vim-indent-guides'
```
and then run the following command from inside Vim: and then run the following command from inside Vim:
:PluginInstall ```vim
:PluginInstall
```
## Usage ## Usage
The default mapping to toggle the plugin is `<Leader>ig`. The default mapping to toggle the plugin is `<Leader>ig`.
You can also use the following commands inside Vim: You can also use the following commands inside Vim:
:IndentGuidesEnable ```vim
:IndentGuidesDisable :IndentGuidesEnable
:IndentGuidesToggle :IndentGuidesDisable
:IndentGuidesToggle
```
If you would like to have indent guides enabled by default, you can add the following to your `~/.vimrc`: If you would like to have indent guides enabled by default, you can add the following to your `~/.vimrc`:
let g:indent_guides_enable_on_vim_startup = 1 ```vim
let g:indent_guides_enable_on_vim_startup = 1
```
### gVim ### gVim
**This plugin should work with gVim out of the box, no configuration needed.** It will automatically inspect your colorscheme and pick appropriate colors. **This plugin should work with gVim out of the box, no configuration needed.** It will automatically inspect your colorscheme and pick appropriate colors.
### Setting custom indent colors ### Setting custom indent colors
Here's an example of how to define custom colors instead of using the ones the plugin automatically generates for you. Add this to your `.vimrc` file: Here's an example of how to define custom colors instead of using the ones the plugin automatically generates for you. Add this to your `.vimrc` file:
let g:indent_guides_auto_colors = 0 ```vim
autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3 let g:indent_guides_auto_colors = 0
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4 autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
```
Alternatively you can add the following lines to your colorscheme file. Alternatively you can add the following lines to your colorscheme file.
hi IndentGuidesOdd guibg=red ctermbg=3 ```vim
hi IndentGuidesEven guibg=green ctermbg=4 hi IndentGuidesOdd guibg=red ctermbg=3
hi IndentGuidesEven guibg=green ctermbg=4
```
### Terminal Vim ### Terminal Vim
At the moment Terminal Vim only has basic support. This means is that colors won't be automatically calculated based on your colorscheme. Instead, some preset colors are used depending on whether `background` is set to `dark` or `light`. At the moment Terminal Vim only has basic support. This means is that colors won't be automatically calculated based on your colorscheme. Instead, some preset colors are used depending on whether `background` is set to `dark` or `light`.
When `set background=dark` is used, the following highlight colors will be defined: When `set background=dark` is used, the following highlight colors will be defined:
hi IndentGuidesOdd ctermbg=black ```vim
hi IndentGuidesEven ctermbg=darkgrey hi IndentGuidesOdd ctermbg=black
hi IndentGuidesEven ctermbg=darkgrey
```
Alternatively, when `set background=light` is used, the following highlight colors will be defined: Alternatively, when `set background=light` is used, the following highlight colors will be defined:
hi IndentGuidesOdd ctermbg=white ```vim
hi IndentGuidesEven ctermbg=lightgrey hi IndentGuidesOdd ctermbg=white
hi IndentGuidesEven ctermbg=lightgrey
```
If for some reason it's incorrectly defining light highlight colors instead of dark ones or vice versa, the first thing you should check is that the `background` value is being set correctly for your colorscheme. Sometimes it's best to manually set the `background` value in your `.vimrc`, for example: If for some reason it's incorrectly defining light highlight colors instead of dark ones or vice versa, the first thing you should check is that the `background` value is being set correctly for your colorscheme. Sometimes it's best to manually set the `background` value in your `.vimrc`, for example:
colorscheme desert256 ```vim
set background=dark colorscheme desert256
set background=dark
```
Alternatively you can manually setup the highlight colors yourself, see `:help indent_guides_auto_colors` for an example. Alternatively you can manually setup the highlight colors yourself, see `:help indent_guides_auto_colors` for an example.