zsh-syntax-highlighting/README.md

80 lines
2.6 KiB
Markdown
Raw Normal View History

2010-12-25 12:47:12 -05:00
zsh-syntax-highlighting
=======================
[Fish shell](http://www.fishshell.org) like syntax highlighting for [Zsh](http://www.zsh.org).
2010-12-25 12:47:12 -05:00
## Try it
2010-12-25 12:47:12 -05:00
Here is a one-liner to try it without installing or modifying anything:
wget --no-check-certificate --output-document=/tmp/zsh-syntax-highlighting.zsh https://github.com/nicoulaj/zsh-syntax-highlighting/raw/master/zsh-syntax-highlighting.zsh && . /tmp/zsh-syntax-highlighting.zsh
## Install it
2011-01-05 04:56:12 -05:00
### Requirements :
zsh 4.3.9 or superior
### In your ~/.zshrc
* Download the script or clone this repository:
2011-01-01 11:49:12 -05:00
git clone git://github.com/nicoulaj/zsh-syntax-highlighting.git
* Source the script at the end of `~/.zshrc`:
2010-12-25 12:47:12 -05:00
2011-01-01 11:49:12 -05:00
source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
* Source `~/.zshrc` to take changes into account:
2011-01-01 11:49:12 -05:00
source ~/.zshrc
### With oh-my-zsh
* Download the script or clone this repository in [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh) plugins directory:
2011-01-01 11:49:12 -05:00
cd ~/.oh-my-zsh/plugins/
git clone git://github.com/nicoulaj/zsh-syntax-highlighting.git
cd zsh-syntax-highlighting
ln -s zsh-syntax-highlighting.zsh zsh-syntax-highlighting.plugin.zsh
2011-01-01 13:17:02 -05:00
* Activate the plugin in `~/.zshrc`:
2011-01-01 11:49:12 -05:00
plugins=(zsh-syntax-highlighting)
* Source `~/.zshrc` to take changes into account:
2011-01-01 11:49:12 -05:00
source ~/.zshrc
## Tweak it
2010-12-25 12:47:12 -05:00
2011-01-01 13:17:02 -05:00
Optionally, you can override the default styles used for highlighting. The styles are declared in the [`ZSH_HIGHLIGHT_STYLES`](https://github.com/nicoulaj/zsh-syntax-highlighting/blob/master/zsh-syntax-highlighting.zsh#L9) array. You can override styles this way:
2011-01-01 13:17:02 -05:00
# To differentiate aliases from other command types
ZSH_HIGHLIGHT_STYLES[alias]='fg=magenta,bold'
# To have paths colored instead of underlined
ZSH_HIGHLIGHT_STYLES[path]='fg=cyan'
# To disable highlighting of globbing expressions
ZSH_HIGHLIGHT_STYLES[globbing]='none'
This must be done **after** the script is sourced, otherwise your styles will be overwritten. The syntax for declaring styles is [documented here](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#SEC135).
2010-12-25 12:47:12 -05:00
2010-12-25 12:47:12 -05:00
## Authors / Greetings
* [Roy Zuo](https://github.com/roylez)
* [Julien Nicoulaud](https://github.com/nicoulaj)
* [Dave Ingram](https://github.com/dingram)
* [Mounier Florian](https://github.com/paradoxxxzero)
* [Jonathan Dahan](https://github.com/jedahan)
2010-12-25 12:47:12 -05:00
* James Ahlborn
* [Andreas Jaggi](https://github.com/x-way)
* [Wayne Davison](https://github.com/WayneD)
* [Suraj N. Kurapati](https://github.com/sunaku)
* [Takeshi Banse](https://github.com/hchbaw)