Merge branch 'marabesi-master'

* marabesi-master:
  Use bash syntax highlighting for terminal commands in the readme
  Add empty lines after fenced code blocks
  Update README.markdown
This commit is contained in:
Nate Kane 2018-05-14 21:32:31 +10:00
commit 54d889a637

View File

@ -22,30 +22,40 @@ To install the plugin copy `autoload`, `plugin`, `doc` directories into your `.v
### 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:
cd ~/.vim/bundle
git clone git://github.com/nathanaelkane/vim-indent-guides.git
```bash
cd ~/.vim/bundle
git clone git://github.com/nathanaelkane/vim-indent-guides.git
```
### 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):
Plugin 'nathanaelkane/vim-indent-guides'
```vim
Plugin 'nathanaelkane/vim-indent-guides'
```
and then run the following command from inside Vim:
:PluginInstall
```vim
:PluginInstall
```
## Usage
The default mapping to toggle the plugin is `<Leader>ig`.
You can also use the following commands inside Vim:
:IndentGuidesEnable
:IndentGuidesDisable
:IndentGuidesToggle
```vim
:IndentGuidesEnable
:IndentGuidesDisable
:IndentGuidesToggle
```
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
**This plugin should work with gVim out of the box, no configuration needed.** It will automatically inspect your colorscheme and pick appropriate colors.
@ -53,32 +63,42 @@ If you would like to have indent guides enabled by default, you can add the foll
### 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:
let g:indent_guides_auto_colors = 0
autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
```vim
let g:indent_guides_auto_colors = 0
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.
hi IndentGuidesOdd guibg=red ctermbg=3
hi IndentGuidesEven guibg=green ctermbg=4
```vim
hi IndentGuidesOdd guibg=red ctermbg=3
hi IndentGuidesEven guibg=green ctermbg=4
```
### 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`.
When `set background=dark` is used, the following highlight colors will be defined:
hi IndentGuidesOdd ctermbg=black
hi IndentGuidesEven ctermbg=darkgrey
```vim
hi IndentGuidesOdd ctermbg=black
hi IndentGuidesEven ctermbg=darkgrey
```
Alternatively, when `set background=light` is used, the following highlight colors will be defined:
hi IndentGuidesOdd ctermbg=white
hi IndentGuidesEven ctermbg=lightgrey
```vim
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:
colorscheme desert256
set background=dark
```vim
colorscheme desert256
set background=dark
```
Alternatively you can manually setup the highlight colors yourself, see `:help indent_guides_auto_colors` for an example.