diff --git a/modules/syntax-highlighting/README.md b/modules/syntax-highlighting/README.md new file mode 100644 index 0000000..38dc28c --- /dev/null +++ b/modules/syntax-highlighting/README.md @@ -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 +