dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2025-07-01 09:19:25 +00:00
Code Issues Releases Wiki Activity

general: Update documentation better qualifying runcom paths

Browse Source 
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.
This commit is contained in:
Indrajit Raychaudhuri
2021-05-05 12:59:01 -05:00
committed by Indrajit Raychaudhuri
parent 424d4cb779
commit 1ff9421f7b
46 changed files with 434 additions and 337 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
modules/syntax-highlighting/README.md
View File

@ -2,14 +2,14 @@
Integrates [zsh-syntax-highlighting][1] into Prezto.
This module should be loaded before the *prompt* module.
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.
[_`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'.
To elaborate, the relative order of loading the modules would be
_`syntax-highlighting`_, _`history-substring-search`_ and _`prompt`_.
## Contributors
@ -22,7 +22,7 @@ This module will be synchronized against it.
### Highlighting
To enable highlighting for this module only, add the following line to
*~/.zpreztorc*:
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:syntax-highlighting' color 'yes'
@ -30,10 +30,11 @@ zstyle ':prezto:module:syntax-highlighting' color 'yes'
### Highlighters
Syntax highlighting is accomplished by pluggable [highlighters][2]. This module
only enables the *main* highlighter by default.
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 *~/.zpreztorc*:
To enable all highlighters, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:syntax-highlighting' highlighters \
@ -50,7 +51,7 @@ zstyle ':prezto:module:syntax-highlighting' highlighters \
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*:
green, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:syntax-highlighting' styles \
@ -61,10 +62,11 @@ zstyle ':prezto:module:syntax-highlighting' styles \
## Authors
*The authors of this module should be contacted via the [issue tracker][3].*
_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]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters
[3]: https://github.com/sorin-ionescu/prezto/issues
[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