From 217669270418fbc6ae98836b09357b5ba8f85b7d Mon Sep 17 00:00:00 2001
From: Nils Luxton <nils.luxton@gmail.com>
Date: Mon, 9 May 2016 17:35:21 +0100
Subject: [PATCH] docs: Added style key prefix convention
Part of #306
---
docs/highlighters.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/highlighters.md b/docs/highlighters.md
index 9b43430..24fc6da 100644
--- a/docs/highlighters.md
+++ b/docs/highlighters.md
@@ -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`: