yujunjun/zsh-syntax-highlighting
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git synced 2025-11-04 12:07:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs copyedit: Rewrap to 80 columns.

Browse Source
This commit is contained in:
Daniel Shahaf 2015-11-17 03:02:39 +00:00
parent 8ea392e361
commit 12097d55d1
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
highlighters/README.md
View File

@ -22,7 +22,9 @@ To activate an highlighter, add it to the `ZSH_HIGHLIGHT_HIGHLIGHTERS` array in
How to tweak highlighters
-------------------------
Highlighters look up styles from the `ZSH_HIGHLIGHT_STYLES` array. Navigate into each highlighter directory to see what styles it defines and how to configure it.
Highlighters look up styles from the `ZSH_HIGHLIGHT_STYLES` array.
Navigate into each highlighter directory to see what styles it defines
and how to configure it.
How to implement a new highlighter
@ -31,14 +33,19 @@ How to implement a new highlighter
To create your own `myhighlighter` highlighter:
* Create your script at `highlighters/${myhighlighter}/${myhighlighter}-highlighter.zsh`.
* Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function. This function must return 0 when the highlighter needs to be called and non-zero otherwise, for example:
* Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function.
This function must return 0 when the highlighter needs to be called and
non-zero otherwise, for example:
_zsh_highlight_myhighlighter_highlighter_predicate() {
# Call this highlighter in SVN repositories
[[ -d .svn ]]
}
* Implement the `_zsh_highlight_myhighlighter_highlighter` function. This function does the actual syntax highlighting, by modifying `region_highlight`, for example:
* Implement the `_zsh_highlight_myhighlighter_highlighter` function.
This function does the actual syntax highlighting, by modifying
`region_highlight`, for example:
_zsh_highlight_myhighlighter_highlighter() {
# Colorize the whole buffer with blue background