xinb
/
zsh-syntax-highlighting
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: highlighters should use _zsh_highlight_add_highlight

This commit is contained in:
Matthew Martin 2016-04-29 21:23:09 -05:00
parent f34714b8ee
commit c346f6eb6f
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/highlighters.md
View File

@ -64,12 +64,17 @@ To create your own `myhighlighter` highlighter:
}
* Implement the `_zsh_highlight_myhighlighter_highlighter` function.
This function does the actual syntax highlighting, by modifying
`region_highlight`, for example:
This function does the actual syntax highlighting, by calling
`_zsh_highlight_add_highlight` with the start and end of the region to
be highlighted and the `ZSH_HIGHLIGHT_STYLES` key to use. Define the default
style for that key in the highlighter script outside of any function with `:
${ZSH_HIGHLIGHT_STYLES[key]:=value}`. For example:
: ${ZSH_HIGHLIGHT_STYLES[aurora]:=fg=green}
_zsh_highlight_myhighlighter_highlighter() {
# Colorize the whole buffer with blue background
region_highlight+=(0 $#BUFFER bg=blue)
# Colorize the whole buffer with the 'aurora' style
_zsh_highlight_add_highlight 0 $#BUFFER aurora
}
* Activate your highlighter in `~/.zshrc`: