docs: add clarifying note in the README about null values (#300)

* readme: Add clarifying note about null values

* readme: Remove duplicate documentation of null values
This commit is contained in:
Yeho 2024-09-13 10:35:24 +03:00 committed by GitHub
parent 8276c5a5e3
commit c43c10fe94
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -85,8 +85,15 @@ This is a diagram of how the theme is split between its components.
## Configuration options ## Configuration options
All flavors support certain levels of customization that match our [Catppuccin All flavors support certain levels of customization that match our [Catppuccin
Style Guide][style-guide]. To add these customizations, add any of the following Style Guide][style-guide]. To add these customizations, you may add any of the
options to your Tmux configuration. following options to your Tmux configuration.
If you want to set a text-based customization to an emtpy string, use `null` to
do so. For instance:
```sh
set -g @catppuccin_icon_window_last "null"
```
### Window ### Window
@ -340,16 +347,6 @@ set -g @catppuccin_[module_name]_color "color"
set -g @catppuccin_[module_name]_text "text" set -g @catppuccin_[module_name]_text "text"
``` ```
#### Removing a specific module option
```sh
set -g @catppuccin_[module_name]_[option] "null"
```
This is for the situation where you want to remove the icon from a module.
Ex:
```sh
set -g @catppuccin_date_time_icon "null"
```
### Battery module ### Battery module
#### Requirements #### Requirements