dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2025-07-01 23: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

24
modules/autosuggestions/README.md
View File

@ -5,13 +5,16 @@ Integrates [zsh-autosuggestions][1] into Prezto, which implements the
of a previously entered command and Zsh suggests commands as you type based on
history and completions.
If this module is used in conjunction with the *syntax-highlighting* module,
this module must be loaded **after** the *syntax-highlighting* module.
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*
module, this module must be loaded **after** the *history-substring-search*
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.
To elaborate, the relative order of loading the modules would be
_`autosuggestions`_, _`syntax-highlighting`_ and _`history-substring-search`_.
## Contributors
New features and bug fixes should be submitted to the [zsh-autosuggestions][1]
@ -22,17 +25,18 @@ against it.
### Highlighting
If colors are enabled, *autosuggestions* will automatically highlight
If colors are enabled, _autosuggestions_ will automatically highlight
positive results.
To enable highlighting for this module only, add the following line to
*~/.zpreztorc*:
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:autosuggestions' color 'yes'
```
To set the query found color, add the following line to *~/.zpreztorc*:
To set the query found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:autosuggestions:color' found ''
@ -47,10 +51,12 @@ also have the `history` module enabled.
## 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][5]._
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[1]: https://github.com/tarruda/zsh-autosuggestions
[2]: https://fishshell.com
[3]: https://github.com/sorin-ionescu/prezto/issues
[3]: ../syntax-highlighting#readme
[4]: ../history-substring-search#readme
[5]: https://github.com/sorin-ionescu/prezto/issues