1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 20:57:59 +00:00
prezto/modules/syntax-highlighting/README.md
Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
2021-05-21 12:31:02 -05:00

1.9 KiB

Syntax Highlighting

Integrates zsh-syntax-highlighting into Prezto.

This module must be loaded before the prompt module.

Additionally, if this module is used in conjunction with the history-substring-search module, this module must be loaded before the history-substring-search module.

To elaborate, the relative order of loading the modules would be syntax-highlighting, history-substring-search and prompt.

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 ${ZDOTDIR:-$HOME}/.zpreztorc:

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

Highlighters

Syntax highlighting is accomplished by pluggable highlighters. This module only enables the main highlighter by default.

To enable all highlighters, add the following to ${ZDOTDIR:-$HOME}/.zpreztorc.

zstyle ':prezto:module:syntax-highlighting' highlighters \
  'main' \
  'brackets' \
  'pattern' \
  'line' \
  '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 ${ZDOTDIR:-$HOME}/.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.