Daniel Shahaf 0ff354b44b docs: Namespace highlighters' styles. Follow-up to `2176692704`. Part of #306.		8 jaren geleden
docs	docs: Namespace highlighters' styles.	8 jaren geleden
highlighters	'main': Don't leak the PATH_DIRS options.	8 jaren geleden
images	Add screenshot.	9 jaren geleden
tests	tests: Followup to last: echo(1) is evil.	8 jaren geleden
.gitattributes	versionstamp: Set up '.revision-hash' file.	9 jaren geleden
.gitignore	docs: Create all.md	8 jaren geleden
.revision-hash	versionstamp: Set up '.revision-hash' file.	9 jaren geleden
.version	Version number bump.	8 jaren geleden
COPYING.md	Bump copyright years.	8 jaren geleden
HACKING.md	dev docs: Document testing quirks	8 jaren geleden
INSTALL.md	docs: Honour $ZDOTDIR in code examples.	8 jaren geleden
Makefile	tests: Add a 'print failures only' mode to 'make test', called 'make quiet-test'.	8 jaren geleden
README.md	docs: Followup to the recent docs branch: clean up some internal cross-references.	8 jaren geleden
changelog.md	changelog: Update for upcoming 0.4.1 release.	8 jaren geleden
release.md	release.md: Add a release checklist line item.	8 jaren geleden
zsh-syntax-highlighting.plugin.zsh	plugin.zsh: Convert from symlink to plain file	8 jaren geleden
zsh-syntax-highlighting.zsh	driver: Track rename of an unreleased upstream API.	8 jaren geleden

README.md

zsh-syntax-highlighting

Fish shell-like like syntax highlighting for Zsh.

Requirements: zsh 4.3.17+.

This package provides syntax highlighing for the shell zsh. It enables highlighing 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.

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.

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.