This repository has been archived on 2022-03-28. You can view files and clone it, but cannot push or open issues or pull requests.
prezto/modules/syntax-highlighting
2014-10-05 20:16:26 -04:00
..
external@3dc5741900 Update external syntax-highlighting 2014-10-05 20:16:26 -04:00
init.zsh Stop module loading when external code fails to source 2013-08-27 22:22:55 -04:00
README.md [#52] Add zstyles to configure syntax-highlighting 2013-04-26 19:47:07 -04:00

Syntax Highlighting

Integrates zsh-syntax-highlighting into Prezto.

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 project according to its rules and regulations. This module will be synchronized against it.

Settings

Highlighting

To enable highlighting for this module only, add the following line to zpreztorc:

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

Highlighters

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

To enable all highlighters, add the following to zpreztorc:

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

Highlighting Styles

Each syntax highlighter defines styles used to highlight tokens.

To highlight, for example, builtins, commands, and functions in blue instead of green, add the following to zpreztorc:

zstyle ':prezto:module:syntax-highlighting' styles \
  'builtin' 'bg=blue' \
  'command' 'bg=blue' \
  'function' 'bg=blue'

Authors

The authors of this module should be contacted via the issue tracker.