RepoMirrors
/
zsh-autosuggestions
mirror of https://github.com/zsh-users/zsh-autosuggestions
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #434 from zsh-users/meta/improve-highlight-style-docs 

Improve documentation for configuring highlight style
This commit is contained in:
Eric Freese 2019-05-29 01:40:20 -06:00 committed by GitHub
parent 48d04447cc b714f6667c
commit de266574d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -34,7 +34,15 @@ You may want to override the default global config variables. Default values of
### Suggestion Highlight Style
Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`.
Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`, which will set the foreground color to color 8 from the 256-color palette. If your terminal only supports 8 colors, you will need to use a number between 0 and 7.
Background color can also be set, and the suggestion can be styled bold, underlined, or standout. For example, this would show suggestions with bold, underlined, pink text on a cyan background:
```sh
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE="fg=#ff00ff,bg=cyan,bold,underline"
```
For more info, read the Character Highlighting section of the zsh manual: `man zshzle` or [online](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting).
### Suggestion Strategy