Go to file

Vítor Galvão 6f7bf8c0f4 README.md: install with oh-my-zsh in a single command		2015-10-20 01:30:52 +01:00
highlighters	command word: Protect against the case that the command word starts with a minus.	2015-10-02 13:27:21 +00:00
tests	Bump copyright years.	2015-09-24 16:46:28 +00:00
.gitattributes	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.gitignore	Ignore zwc files	2011-09-06 19:15:09 +02:00
.revision-hash	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.version	Set the version number.	2015-10-19 07:20:57 +00:00
changelog.md	changelog: Extend 'suffix aliases' entry.	2015-10-19 08:05:58 +00:00
COPYING.md	Bump copyright years, part 2.	2015-09-24 16:48:27 +00:00
Makefile	'make test': Pass -f to zsh to minimize environmental variation.	2015-10-19 14:26:01 +00:00
README.md	README.md: install with oh-my-zsh in a single command	2015-10-20 01:30:52 +01:00
release.md	dev: Document the release process (first draft).	2015-10-19 13:59:30 +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	Revert "Do wrap the 'yank' widget, because that works."	2015-10-19 13:40:51 +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:

  git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting

Activate the plugin in ~/.zshrc:

  plugins=( [plugins...] zsh-syntax-highlighting)

Source ~/.zshrc to take changes into account:
```
  source ~/.zshrc
```

Note that zsh-syntax-highlighting must be the last plugin sourced, so make it the last element of the $plugins array.

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.