dcarrillo
/
prezto
mirror of https://github.com/dcarrillo/prezto.git
1
0
Fork 0
Code Issues Releases Wiki Activity

general: Clarify relative ordering of modules in docs

This commit is contained in:
Indrajit Raychaudhuri 2021-07-03 12:26:46 -05:00 committed by Indrajit Raychaudhuri
parent f3c92ffeb3
commit 2451239713
3 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
modules/autosuggestions/README.md
View File

@ -8,12 +8,12 @@ history and completions.
If this module is used in conjunction with the [_`syntax-highlighting`_][3] If this module is used in conjunction with the [_`syntax-highlighting`_][3]
module, this module must be loaded _after_ the _`syntax-highlighting`_ module. module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
If this module is used in conjunction with the [_`history-substring-search`_][4] Additionally, if this module is used in conjunction with the
module, this module must be loaded _after_ the _`history-substring-search`_ [_`history-substring-search`_][4] module, this module must be loaded _after_ the
module. _`history-substring-search`_ module as well.
To elaborate, the relative order of loading the modules would be To elaborate, the relative order of loading the modules would be
_`autosuggestions`_, _`syntax-highlighting`_ and _`history-substring-search`_. _`syntax-highlighting`_, _`history-substring-search`_ and _`autosuggestions`_.
## Contributors ## Contributors

12
modules/history-substring-search/README.md
View File

@ -8,6 +8,13 @@ commands.
If this module is used in conjunction with the [_`syntax-highlighting`_][3] If this module is used in conjunction with the [_`syntax-highlighting`_][3]
module, this module must be loaded _after_ the _`syntax-highlighting`_ module. module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
Additionally, if this module is used in conjunction with the
[_`autosuggestions`_][4] module, this module must be loaded _before_ the
_`autosuggestions`_ module.
To elaborate, the relative order of loading the modules would be
_`syntax-highlighting`_, _`history-substring-search`_ and _`autosuggestions`_.
## Contributors ## Contributors
New features and bug fixes should be submitted to the New features and bug fixes should be submitted to the
@ -60,7 +67,7 @@ zstyle ':prezto:module:history-substring-search' globbing-flags ''
## Authors ## Authors
_The authors of this module should be contacted via the [issue tracker][4]._ _The authors of this module should be contacted via the [issue tracker][5]._
- [Suraj N. Kurapati](https://github.com/sunaku) - [Suraj N. Kurapati](https://github.com/sunaku)
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
@ -68,4 +75,5 @@ _The authors of this module should be contacted via the [issue tracker][4]._
[1]: https://github.com/zsh-users/zsh-history-substring-search [1]: https://github.com/zsh-users/zsh-history-substring-search
[2]: https://fishshell.com [2]: https://fishshell.com
[3]: ../syntax-highlighting#readme [3]: ../syntax-highlighting#readme
[4]: https://github.com/sorin-ionescu/prezto/issues [4]: ../autosuggestions#readme
[5]: https://github.com/sorin-ionescu/prezto/issues

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

@ -4,12 +4,17 @@ Integrates [zsh-syntax-highlighting][1] into Prezto.
This module must be loaded _before_ the _`prompt`_ module. This module must be loaded _before_ the _`prompt`_ module.
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.
Additionally, if this module is used in conjunction with the Additionally, if this module is used in conjunction with the
[_`history-substring-search`_][2] module, this module must be loaded _before_ [_`autosuggestions`_][3] module, this module must be loaded _before_ the
the _`history-substring-search`_ module. _`autosuggestions`_ module as well.
To elaborate, the relative order of loading the modules would be To elaborate, the relative order of loading the modules would be
_`syntax-highlighting`_, _`history-substring-search`_ and _`prompt`_. _`syntax-highlighting`_, _`history-substring-search`_, _`autosuggestions`_ and
_`prompt`_.
## Contributors ## Contributors
@ -30,7 +35,7 @@ zstyle ':prezto:module:syntax-highlighting' color 'yes'
### Highlighters ### Highlighters
Syntax highlighting is accomplished by pluggable [highlighters][3]. This module Syntax highlighting is accomplished by pluggable [highlighters][4]. This module
only enables the _main_ highlighter by default. only enables the _main_ highlighter by default.
To enable all highlighters, add the following to To enable all highlighters, add the following to
@ -62,11 +67,12 @@ zstyle ':prezto:module:syntax-highlighting' styles \
## Authors ## Authors
_The authors of this module should be contacted via the [issue tracker][4]._ _The authors of this module should be contacted via the [issue tracker][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu) - [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/zsh-users/zsh-syntax-highlighting [1]: https://github.com/zsh-users/zsh-syntax-highlighting
[2]: ../history-substring-search#readme [2]: ../history-substring-search#readme
[3]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters [3]: ../autosuggestions#readme
[4]: https://github.com/sorin-ionescu/prezto/issues [4]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters
[5]: https://github.com/sorin-ionescu/prezto/issues