Skip to content

Commit

Permalink
[Fix sorin-ionescu#118] Add documentation for syntax-highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
RIT80 authored and RIT80 committed Jun 14, 2012
1 parent 816fe90 commit d88e86f
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions modules/syntax-highlighting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Syntax Highlighting
===================

Integrates [zsh-syntax-highlighting][1] into Oh My Zsh.

This module should be loaded *second to last*, where last is the *prompt*
module, unless used in conjuncture with the *history-substring-search* module
where it must be loaded **before** it.

Contributors
------------

New features and bug fixes should be submitted to the
[zsh-syntax-highlighting][1] project according to its rules and regulations.
This module will be synchronized against it.

Settings
--------

### Highlighting

To enable highlighting for this module only, and the following line to *zshrc*:

zstyle ':omz:module:syntax-highlighting' color 'yes'

### Highlighters

Syntax highlighting is accomplished by pluggable [highlighters][2]. This module
enables the *main*, *brackets*, and *cursor* highlighters by default.

To enable all highlighters, add the following to *zshrc*:

zstyle ':omz:module:syntax-highlighting' highlighters \
'main' \
'brackets' \
'pattern' \
'cursor' \
'root'

Authors
-------

*The authors of this module should be contacted via the [issue tracker][3].*

- [Sorin Ionescu](https://github.com/sorin-ionescu)

[1]: https://github.com/zsh-users/zsh-syntax-highlighting
[2]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters
[3]: https://github.com/sorin-ionescu/oh-my-zsh/issues

0 comments on commit d88e86f

Please sign in to comment.