mirror of https://github.com/zsh-users/zsh-syntax-highlighting synced 2024-12-20 02:10:11 +00:00

Fish shell like syntax highlighting for Zsh.

Go to file

Daniel Shahaf 8a43bd2cd9 back-dollar-quoted-argument: Highlight \uHHHH and \UHHHHHHHH escapes.		2015-09-25 21:45:38 +00:00
highlighters	back-dollar-quoted-argument: Highlight \uHHHH and \UHHHHHHHH escapes.	2015-09-25 21:45:38 +00:00
tests	Bump copyright years.	2015-09-24 16:46:28 +00:00
.gitignore	Ignore zwc files	2011-09-06 19:15:09 +02:00
COPYING.md	Bump copyright years, part 2.	2015-09-24 16:48:27 +00:00
README.md	README: Document release announcements.	2015-09-24 23:00:05 +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	Fix errors with non-reserved-word typeset.	2015-09-25 17:53:22 +00:00

README.md

zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.

Requirements: zsh 4.3.17+.

How to install

Using packages

Arch Linux: community/zsh-syntax-highlighting / AUR/zsh-syntax-highlighting-git
Gentoo: mv overlay
Mac OS X / Homebrew: brew install zsh-syntax-highlighting

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 and after running compinit). Widgets created later will work, but will not update the syntax highlighting.

How are new releases announced?

There is currently no "push" announcements channel. However, the following alternatives exist:

GitHub's RSS feed of releases: https://github.com/zsh-users/zsh-syntax-highlighting/releases.atom
An anitya entry: https://release-monitoring.org/project/7552/

How to tweak

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