mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git synced 2025-02-13 10:05:31 +08:00

History

Ben Boeckel 0916794aeb Check for partial paths separately It's really annoying to have partial paths appear the same as paths to complete files. However, it is still nice to be able to highlight them. Full paths are now bold while partial paths use plain underline.		2013-07-25 00:25:48 -04:00
..
brackets	Fix bracket highlighter	2012-04-07 17:09:15 +02:00
cursor	Add cursor highlighter	2011-07-27 00:13:41 +02:00
main	Check for partial paths separately	2013-07-25 00:25:48 -04:00
pattern	make $pattern local to _zsh_highlight_pattern_highlighter #97	2012-12-09 10:43:00 +09:00
root	Add highlighter triggered when the user is root	2011-07-27 00:37:33 +02:00
README.md	Fix relative links in highlighters readme	2013-02-26 18:03:35 -08:00

README.md

zsh-syntax-highlighting / highlighters

Syntax highlighting is done by pluggable highlighters:

main - the base highlighter, and the only one active by default.
brackets - matches brackets and parenthesis.
pattern - matches user-defined patterns.
cursor - matches the cursor position.
root - triggered if the current user is root.

How to activate highlighters

To activate an highlighter, add it to the ZSH_HIGHLIGHT_HIGHLIGHTERS array in ~/.zshrc, for example:

ZSH_HIGHLIGHT_HIGHLIGHTERS=(main brackets pattern cursor)

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.

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, 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:
```
  _zsh_highlight_myhighlighter_highlighter() {
    # Colorize the whole buffer with blue background
    region_highlight+=(0 $#BUFFER bg=blue)
  }
```

Activate your highlighter in ~/.zshrc:

  ZSH_HIGHLIGHT_HIGHLIGHTERS+=(myhighlighter)