Go to file
Daniel Shahaf 00862cf4fa Followup to e5c2a88db0 (merged in 51102bf83f):
Have widgets return EXIT_SUCCESS.
2015-09-18 12:38:24 +00:00
highlighters tests: vanilla-newline.zsh: Fix expectations 2015-09-17 23:33:56 +00:00
tests tests: Let each test change the highlight styles. 2015-09-17 23:35:44 +00:00
.gitignore Ignore zwc files 2011-09-06 19:15:09 +02:00
COPYING.md Split off contributors list to a separate file 2011-02-01 21:07:00 +01:00
README.md docs: Document homebrew package name. 2015-09-05 19:21:52 +00:00
zsh-syntax-highlighting.plugin.zsh Added oh-my-zsh zsh-syntax-highlighting plugin. 2011-01-06 05:47:42 +08:00
zsh-syntax-highlighting.zsh Followup to e5c2a88db0 (merged in 51102bf83f): 2015-09-18 12:38:24 +00:00

zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.

Requirements: zsh 4.3.17+.

How to install

Using packages

In your ~/.zshrc

  • Clone this repository:

      git clone git://github.com/zsh-users/zsh-syntax-highlighting.git
    

    (or download a snapshot)

  • Source the script at the end of ~/.zshrc:

      source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
    
  • Source ~/.zshrc to take changes into account:

      source ~/.zshrc
    

With oh-my-zsh

  • Download the script or clone this repository in oh-my-zsh plugins directory:

      cd ~/.oh-my-zsh/custom/plugins
      git clone git://github.com/zsh-users/zsh-syntax-highlighting.git
    
  • Activate the plugin in ~/.zshrc (in last position):

      plugins=( [plugins...] zsh-syntax-highlighting)
    
  • Source ~/.zshrc to take changes into account:

      source ~/.zshrc
    

FAQ

Why must zsh-syntax-highlighting.zsh be sourced at the end of the .zshrc file?

zsh-syntax-highlighting.zsh wraps ZLE widgets. It must be sourced after all custom widgets have been created (i.e., after all zle -N calls).

How to tweak

Syntax highlighting is done by pluggable highlighter scripts, see the highlighters directory for documentation and configuration settings.