diff options
| author | Aman Kumar Sinha <45752299+Perniciosius@users.noreply.github.com> | 2021-10-04 23:16:33 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-04 19:46:33 +0200 |
| commit | f8e81a162242cbd65a0802435e3efbd9dedc034a (patch) | |
| tree | a4533f8568250a938820da5785df6e8f9d44f985 /docs | |
| parent | e74f428615b957c7dd359ec24bb98a5db612a966 (diff) | |
feat(shell): Add style config for shell module (#3108)
* add style config for shell module
* update shell docs
* fix formatting
* update tests
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index fbabf80dd..68ffac0b8 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -2707,25 +2707,29 @@ To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ---------------------- | --------------- | ------------------------------------------------------------ | -| `bash_indicator` | `"bsh"` | A format string used to represent bash. | -| `fish_indicator` | `"fsh"` | A format string used to represent fish. | -| `zsh_indicator` | `"zsh"` | A format string used to represent zsh. | -| `powershell_indicator` | `"psh"` | A format string used to represent powershell. | -| `ion_indicator` | `"ion"` | A format string used to represent ion. | -| `elvish_indicator` | `"esh"` | A format string used to represent elvish. | -| `tcsh_indicator` | `"tsh"` | A format string used to represent tcsh. | -| `xonsh_indicator` | `"xsh"` | A format string used to represent xonsh. | -| `unknown_indicator` | `""` | The default value to be displayed when the shell is unknown. | -| `format` | `"$indicator "` | The format for the module. | -| `disabled` | `true` | Disables the `shell` module. | +| Option | Default | Description | +| ---------------------- | ------------------------- | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `xonsh_indicator` | `xsh` | A format string used to represent xonsh. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `"[$indicator]($style) "` | The format for the module. | +| `style` | `"white bold"` | The style for the module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables | Variable | Default | Description | | ----------- | ------- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | +| style\* | | Mirrors the value of option `style`. | + +\*: This variable can only be used as a part of a style string ### Examples @@ -2736,6 +2740,7 @@ To enable it, set `disabled` to `false` in your configuration file. fish_indicator = "" powershell_indicator = "_" unknown_indicator = "mystery shell" +style = "cyan bold" disabled = false ``` |