mirror of
https://github.com/dcarrillo/prezto.git
synced 2024-12-23 04:28:00 +00:00
1ff9421f7b
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.
73 lines
1.9 KiB
Markdown
73 lines
1.9 KiB
Markdown
# Syntax Highlighting
|
|
|
|
Integrates [zsh-syntax-highlighting][1] into Prezto.
|
|
|
|
This module must be loaded _before_ the _`prompt`_ module.
|
|
|
|
Additionally, if this module is used in conjunction with the
|
|
[_`history-substring-search`_][2] 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][1] 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`_:
|
|
|
|
```sh
|
|
zstyle ':prezto:module:syntax-highlighting' color 'yes'
|
|
```
|
|
|
|
### Highlighters
|
|
|
|
Syntax highlighting is accomplished by pluggable [highlighters][3]. This module
|
|
only enables the _main_ highlighter by default.
|
|
|
|
To enable all highlighters, add the following to
|
|
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
|
|
|
|
```sh
|
|
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`_:
|
|
|
|
```sh
|
|
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][4]._
|
|
|
|
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
|
|
|
[1]: https://github.com/zsh-users/zsh-syntax-highlighting
|
|
[2]: ../history-substring-search#readme
|
|
[3]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters
|
|
[4]: https://github.com/sorin-ionescu/prezto/issues
|