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

docs: Added style key prefix convention 

Part of #306
This commit is contained in:
Nils Luxton 2016-05-09 17:35:21 +01:00
parent 15db71abd0
commit 2176692704
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/highlighters.md
View File

@ -68,13 +68,14 @@ To create your own `myhighlighter` highlighter:
`_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[key]:=value}`, being sure to prefix
the key with your highlighter name. For example:
: ${ZSH_HIGHLIGHT_STYLES[aurora]:=fg=green}
: ${ZSH_HIGHLIGHT_STYLES[myhighlighter-aurora]:=fg=green}
_zsh_highlight_myhighlighter_highlighter() {
# Colorize the whole buffer with the 'aurora' style
_zsh_highlight_add_highlight 0 $#BUFFER aurora
_zsh_highlight_add_highlight 0 $#BUFFER myhighlighter-aurora
}
* Activate your highlighter in `~/.zshrc`: