readme: add code highlighting

This commit is contained in:
Marco Hinz 2013-03-21 15:04:08 +01:00
parent 43e0f677cd
commit afba2048ba

View File

@ -96,8 +96,10 @@ is set nevertheless because a remote connection could be made.
There are mappings for jumping forth and back between changed lines (so-called
hunks). The following example shows the default mappings and how to change them:
let g:signify_mapping_next_hunk = '<leader>gj'
let g:signify_mapping_prev_hunk = '<leader>gk'
```vim
let g:signify_mapping_next_hunk = '<leader>gj'
let g:signify_mapping_prev_hunk = '<leader>gk'
```
Note: In case you don't know about the mapleader, have a look at `:h mapleader`.
The default is the '\' button.
@ -107,20 +109,26 @@ The default is the '\' button.
Sy shows you signs for changed lines. Moveover, you can enable highlighting of
the concerned lines:
let g:signify_mapping_toggle_highlight = '<leader>gh'
```vim
let g:signify_mapping_toggle_highlight = '<leader>gh'
```
You can also change the highlighting classes for these lines. The defaults are:
let g:signify_line_color_add = 'DiffAdd'
let g:signify_line_color_delete = 'DiffDelete'
let g:signify_line_color_change = 'DiffChange'
```vim
let g:signify_line_color_add = 'DiffAdd'
let g:signify_line_color_delete = 'DiffDelete'
let g:signify_line_color_change = 'DiffChange'
```
#### you can toggle the plugin per buffer
In case you want to disable the plugin for the current buffer, you can toggle
it:
let g:signify_mapping_toggle = '<leader>gt'
```vim
let g:signify_mapping_toggle = '<leader>gt'
```
#### exception lists for filetypes and filenames
@ -129,8 +137,10 @@ you explicitely have to create exception lists:
Example:
let g:signify_exceptions_filetype = [ 'vim', 'c' ]
let g:signify_exceptions_filename = [ '.vimrc' ]
```vim
let g:signify_exceptions_filetype = [ 'vim', 'c' ]
let g:signify_exceptions_filename = [ '.vimrc' ]
```
#### good documentation
@ -138,13 +148,13 @@ You should know by now!
## Installation
I suggest using tpope's plain and awesome pathogen:
I suggest using tpope's pathogen:
- https://github.com/tpope/vim-pathogen
Afterwards, just clone vim-signify into ~/.vim/bundle/.
## Usage
## Documentation
`:h signify`
@ -152,45 +162,47 @@ Afterwards, just clone vim-signify into ~/.vim/bundle/.
For more info: `:h signify-options`
let g:signify_mapping_next_hunk = '<leader>gn'
let g:signify_mapping_prev_hunk = '<leader>gp'
```vim
let g:signify_mapping_next_hunk = '<leader>gn'
let g:signify_mapping_prev_hunk = '<leader>gp'
let g:signify_mapping_toggle_highlight = '<leader>gh'
let g:signify_mapping_toggle = '<leader>gt'
let g:signify_mapping_toggle_highlight = '<leader>gh'
let g:signify_mapping_toggle = '<leader>gt'
let g:signify_exceptions_filetype = [ 'vim', 'c' ]
let g:signify_exceptions_filename = [ '.vimrc' ]
let g:signify_exceptions_filetype = [ 'vim', 'c' ]
let g:signify_exceptions_filename = [ '.vimrc' ]
let g:signify_sign_overwrite = 1
let g:signify_sign_overwrite = 1
let g:signify_sign_add = '+'
let g:signify_sign_delete = '-'
let g:signify_sign_change = '*'
let g:signify_sign_delete = '-'
let g:signify_sign_delete_first_line = '‾'
let g:signify_sign_add = '+'
let g:signify_sign_delete = '-'
let g:signify_sign_change = '*'
let g:signify_sign_delete = '-'
let g:signify_sign_delete_first_line = '‾'
let g:signify_sign_color_guifg_add = '#00ff00'
let g:signify_sign_color_guifg_delete = '#ff0000'
let g:signify_sign_color_guifg_change = '#ffff00'
let g:signify_sign_color_guibg = '#111111'
let g:signify_sign_color_guifg_add = '#00ff00'
let g:signify_sign_color_guifg_delete = '#ff0000'
let g:signify_sign_color_guifg_change = '#ffff00'
let g:signify_sign_color_guibg = '#111111'
let g:signify_sign_color_ctermfg_add = 2
let g:signify_sign_color_ctermfg_delete = 1
let g:signify_sign_color_ctermfg_change = 3
let g:signify_sign_color_ctermbg = 0
let g:signify_sign_color_ctermfg_add = 2
let g:signify_sign_color_ctermfg_delete = 1
let g:signify_sign_color_ctermfg_change = 3
let g:signify_sign_color_ctermbg = 0
let g:signify_sign_color_group_add = 'MyAdd'
let g:signify_sign_color_group_delete = 'MyDelete'
let g:signify_sign_color_group_change = 'MyChange'
let g:signify_sign_color_group_add = 'MyAdd'
let g:signify_sign_color_group_delete = 'MyDelete'
let g:signify_sign_color_group_change = 'MyChange'
let g:signify_line_color_add = 'DiffAdd'
let g:signify_line_color_delete = 'DiffDelete'
let g:signify_line_color_change = 'DiffChange'
let g:signify_line_color_add = 'DiffAdd'
let g:signify_line_color_delete = 'DiffDelete'
let g:signify_line_color_change = 'DiffChange'
let g:signify_enable_cvs = 1
let g:signify_enable_cvs = 1
let g:signify_cursorhold_normal = 1
let g:signify_cursorhold_insert = 1
let g:signify_cursorhold_normal = 1
let g:signify_cursorhold_insert = 1
```
## Author