diff --git a/modules/autosuggestions/README.md b/modules/autosuggestions/README.md index a3e86c2..8aedb31 100644 --- a/modules/autosuggestions/README.md +++ b/modules/autosuggestions/README.md @@ -8,12 +8,12 @@ history and completions. If this module is used in conjunction with the [_`syntax-highlighting`_][3] module, this module must be loaded _after_ the _`syntax-highlighting`_ module. -If this module is used in conjunction with the [_`history-substring-search`_][4] -module, this module must be loaded _after_ the _`history-substring-search`_ -module. +Additionally, if this module is used in conjunction with the +[_`history-substring-search`_][4] module, this module must be loaded _after_ the +_`history-substring-search`_ module as well. 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 diff --git a/modules/autosuggestions/external b/modules/autosuggestions/external index ae315de..a411ef3 160000 --- a/modules/autosuggestions/external +++ b/modules/autosuggestions/external @@ -1 +1 @@ -Subproject commit ae315ded4dba10685dbbafbfa2ff3c1aefeb490d +Subproject commit a411ef3e0992d4839f0732ebeb9823024afaaaa8 diff --git a/modules/history-substring-search/README.md b/modules/history-substring-search/README.md index 5e8eeb0..3a109c5 100644 --- a/modules/history-substring-search/README.md +++ b/modules/history-substring-search/README.md @@ -8,6 +8,13 @@ commands. If this module is used in conjunction with the [_`syntax-highlighting`_][3] 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 New features and bug fixes should be submitted to the @@ -60,7 +67,7 @@ zstyle ':prezto:module:history-substring-search' globbing-flags '' ## 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) - [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 [2]: https://fishshell.com [3]: ../syntax-highlighting#readme -[4]: https://github.com/sorin-ionescu/prezto/issues +[4]: ../autosuggestions#readme +[5]: https://github.com/sorin-ionescu/prezto/issues diff --git a/modules/syntax-highlighting/README.md b/modules/syntax-highlighting/README.md index 2f6ea52..3debb67 100644 --- a/modules/syntax-highlighting/README.md +++ b/modules/syntax-highlighting/README.md @@ -4,12 +4,17 @@ Integrates [zsh-syntax-highlighting][1] into Prezto. 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 -[_`history-substring-search`_][2] module, this module must be loaded _before_ -the _`history-substring-search`_ module. +[_`autosuggestions`_][3] module, this module must be loaded _before_ the +_`autosuggestions`_ module as well. 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 @@ -30,7 +35,7 @@ zstyle ':prezto:module:syntax-highlighting' color 'yes' ### 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. To enable all highlighters, add the following to @@ -62,11 +67,12 @@ zstyle ':prezto:module:syntax-highlighting' styles \ ## 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) [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 +[3]: ../autosuggestions#readme +[4]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters +[5]: https://github.com/sorin-ionescu/prezto/issues diff --git a/runcoms/README.md b/runcoms/README.md index 277e833..39feb7d 100644 --- a/runcoms/README.md +++ b/runcoms/README.md @@ -2,10 +2,10 @@ Zsh has several system-wide and user-local configuration files. -Prezto has one user-local configuration file. +Additionally, Prezto has one user-local configuration file. System-wide configuration files are installation-dependent but are installed -in *`/etc`* by default. +in _`/etc`_ by default. User-local configuration files have the same name as their global counterparts but are prefixed with a dot (hidden). Zsh looks for these files in the path @@ -16,17 +16,17 @@ not defined, Zsh will use the user's home directory. The [configuration files][1] are read in the following order: -01. *`/etc/zshenv`* -02. *`${ZDOTDIR:-$HOME}/.zshenv`* -03. *`/etc/zprofile`* -04. *`${ZDOTDIR:-$HOME}/.zprofile`* -05. *`/etc/zshrc`* -06. *`${ZDOTDIR:-$HOME}/.zshrc`* -07. *`${ZDOTDIR:-$HOME}/.zpreztorc`* -08. *`/etc/zlogin`* -09. *`${ZDOTDIR:-$HOME}/.zlogin`* -10. *`${ZDOTDIR:-$HOME}/.zlogout`* -11. *`/etc/zlogout`* +1. _`/etc/zshenv`_ +2. _`${ZDOTDIR:-$HOME}/.zshenv`_ +3. _`/etc/zprofile`_ +4. _`${ZDOTDIR:-$HOME}/.zprofile`_ +5. _`/etc/zshrc`_ +6. _`${ZDOTDIR:-$HOME}/.zshrc`_ +7. _`${ZDOTDIR:-$HOME}/.zpreztorc`_ +8. _`/etc/zlogin`_ +9. _`${ZDOTDIR:-$HOME}/.zlogin`_ +10. _`${ZDOTDIR:-$HOME}/.zlogout`_ +11. _`/etc/zlogout`_ ### zshenv @@ -35,11 +35,11 @@ small as possible and should only define environment variables. ### zprofile -This file is similar to *zlogin*, but it is sourced before *zshrc*. It was added -for [KornShell][2] fans. See the description of *zlogin* below for what it may +This file is similar to _zlogin_, but it is sourced before _zshrc_. It was added +for [KornShell][2] fans. See the description of _zlogin_ below for what it may contain. -*zprofile* and *zlogin* are not meant to be used together but can be done so. +_zprofile_ and _zlogin_ are not meant to be used together but can be done so. ### zshrc @@ -52,9 +52,9 @@ This file configures Prezto. ### zlogin -This file is sourced by login shells after *zshrc*. Thus, it should contain +This file is sourced by login shells after _zshrc_. Thus, it should contain commands that need to execute at login. It is usually used for messages such as -[*fortune*][3], [*msgs*][4], or for the creation of files. +[_`fortune`_][3], [_`msgs`_][4], or for the creation of files. This is not the file to define aliases, functions, shell options, and key bindings. It should not change the shell environment. @@ -66,7 +66,7 @@ displaying messages and for deletion of files. ## Authors -*The authors of these files should be contacted via the [issue tracker][5].* +_The authors of these files should be contacted via the [issue tracker][5]._ - [Sorin Ionescu](https://github.com/sorin-ionescu)