diff options
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 9756484de..035c11caa 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -339,6 +339,7 @@ $aws\ $gcloud\ $openstack\ $azure\ +$nats\ $direnv\ $env_var\ $crystal\ @@ -2937,6 +2938,35 @@ truncation_length = 4 truncation_symbol = '' ``` +## NATS + +The `nats` module shows the name of the current [NATS](https://nats.io) context. + +### Options + +| Option | Default | Description | +| ---------- | -------------------------- | ------------------------------------------------------------ | +| `symbol` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'[$symbol$name]($style)'` | The format for the module. | +| `disabled` | `false` | Disables the `nats` module. | + +### Variables + +| Variable | Example | Description | +| -------- | ----------- | ------------------------------------ | +| name | `localhost` | The name of the NATS context | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +### Example + +```toml +[nats] +format = '[$symbol]($style)' +style = 'bold purple' +``` + ## Nim The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). @@ -4062,7 +4092,7 @@ threshold = 3 Using `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return -status code and preceeding characters are provided by `shlvl`. +status code and preceding characters are provided by `shlvl`. ```toml # ~/.config/starship.toml |