Add instructions about initializing variable

Many users use modular configuration loaders for zshrc. Adding a note to users explaining how to define ZSH_HIGHLIGHT_PATTERNS before sourcing zsh-syntax-highlighting. The typeset is important, since simply setting the variable doesn't have the desired effect.
This commit is contained in:
Ivan Smirnov 2018-08-20 16:49:39 -07:00 committed by GitHub
parent db6cac391b
commit f19ff89432
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -14,6 +14,8 @@ To use this highlighter, associate patterns with styles in the
The syntax for values is the same as the syntax of "types of highlighting" of
the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`
manual page][zshzle-Character-Highlighting].
manual page][zshzle-Character-Highlighting]. Note: if you would like to define this
variable before you source zsh-syntax-highlighting, you will need to declare it first with:
`typeset -gA ZSH_HIGHLIGHT_PATTERNS`.
[zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting