mirror of https://github.com/zsh-users/zsh-syntax-highlighting synced 2024-12-15 16:04:38 +00:00

Fish shell like syntax highlighting for Zsh.

Go to file

Daniel Shahaf 1f1ad09e38 docs: Restore (with changes) links removed in `f5ca4b891b`. The preceding commit, which made docs/highlighters.md and highlighters/README.md distinct, allows reverting their removal.		2015-11-27 04:07:02 +00:00
docs	docs: Restore (with changes) links removed in `f5ca4b891b`.	2015-11-27 04:07:02 +00:00
highlighters	docs: Followup to the recent docs branch: clean up some internal cross-references.	2015-11-27 04:07:02 +00:00
images	Add screenshot.	2015-10-24 10:59:20 +00:00
tests	docs copyedit: Rewrap to 80 columns, part 3.	2015-11-24 06:06:16 +00:00
.gitattributes	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.gitignore	docs: Create all.md	2015-11-24 00:22:26 -06:00
.revision-hash	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.version	Post-release version number bump.	2015-10-20 14:35:21 +00:00
changelog.md	docs copyedit: Whitespace.	2015-11-24 06:06:16 +00:00
COPYING.md	Bump copyright years, part 2.	2015-09-24 16:48:27 +00:00
INSTALL.md	docs; INSTALL.md: Make 'system-wide' section easier to read.	2015-11-26 18:09:43 +00:00
Makefile	docs: Create all.md	2015-11-24 00:22:26 -06:00
README.md	docs: Followup to the recent docs branch: clean up some internal cross-references.	2015-11-27 04:07:02 +00:00
release.md	release.md: Add an IRC task.	2015-10-20 14:41:55 +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	versionstamp: Better $ZSH_HIGHLIGHT_REVISION reporting when running from git.	2015-11-25 03:55:20 +00:00

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.