public/zsh-syntax-highlighting
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git synced 2025-10-23 15:46:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Fish shell like syntax highlighting for Zsh.
329 Commits 6 Branches 17 Tags 2.7 MiB
Shell 99.4%
Perl 0.3%
Makefile 0.3%
43386376d8
Go to file
Daniel Shahaf 43386376d8 Set the version number. 
Store it in a separate file so OS packages and 'make install' (issue #177) can
reuse it.
2015-10-19 07:20:57 +00: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
.gitignore Ignore zwc files 2011-09-06 19:15:09 +02:00
.version Set the version number. 2015-10-19 07:20:57 +00:00
COPYING.md Bump copyright years, part 2. 2015-09-24 16:48:27 +00:00
Makefile Makefile: have the default invocation safer. 2015-10-19 07:08:42 +00:00
README.md docs: Clarify oh-my-zsh installation instructions 2015-10-18 12:46:27 +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 Set the version number. 2015-10-19 07:20:57 +00:00

README.md

zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.

Requirements: zsh 4.3.17+.

How to install

Using packages

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:

      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:

How to tweak

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