Daniel Shahaf f5d1be7ec2 editorconfig: Fix Makefile settings		vor 4 Jahren
docs	'main': Let AUTO_CD directories be highlighted with their own style.	vor 4 Jahren
highlighters	Fix typo	vor 4 Jahren
images	Highlight redirections by default, and add that to the examples in README.	vor 4 Jahren
tests	test harness: Fix the pretty-printer's padding implementation.	vor 4 Jahren
.editorconfig	editorconfig: Fix Makefile settings	vor 4 Jahren
.gitattributes	versionstamp: Set up '.revision-hash' file.	vor 9 Jahren
.gitignore	docs: Create all.md	vor 8 Jahren
.revision-hash	versionstamp: Set up '.revision-hash' file.	vor 9 Jahren
.travis.yml	Revert "test harness: Rewrite the columnar pretty-printer without external tools." and "travis: Remove bsdmainutils since column(1) has been removed, three commits ago."	vor 4 Jahren
.version	Post-release version number bump.	vor 4 Jahren
COPYING.md	Bump copyright years.	vor 4 Jahren
HACKING.md	docs: Enable Syntax Highlighting for Code Snippits	vor 5 Jahren
INSTALL.md	docs: Track FreeBSD port rename	vor 4 Jahren
Makefile	make test: Re-enable syntax highlighting of TAP output in interactive runs	vor 4 Jahren
README.md	Highlight redirections by default, and add that to the examples in README.	vor 4 Jahren
changelog.md	'main': Support the 'env' precommand.	vor 4 Jahren
release.md	release.md: Update with the step that was missed in 0.7.0.	vor 4 Jahren
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	vor 8 Jahren
zsh-syntax-highlighting.zsh	Bump copyright years.	vor 4 Jahren

README.md

zsh-syntax-highlighting

Fish shell-like syntax highlighting for Zsh.

Requirements: zsh 4.3.11+.

This package provides syntax highlighting for the shell zsh. It enables highlighting of commands whilst they are typed at a zsh prompt into an interactive terminal. This helps in reviewing commands before running them, particularly in catching syntax errors.

Some examples:

Before:
After:

How to install

See INSTALL.md.

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.

Does syntax highlighting work during incremental history search?

Highlighting the command line during an incremental history search (by default bound to to Ctrl+R in zsh's emacs keymap) requires zsh 5.4 or newer.

Under zsh versions older than 5.4, the zsh-default underlining of the matched portion of the buffer remains available, but zsh-syntax-highlighting's additional highlighting is unavailable. (Those versions of zsh do not provide enough information to allow computing the highlighting correctly.)

See issues #288 and #415 for details.

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 documentation on highlighters for details and configuration settings.