Adding the initial pass at documentation;

I'm aiming for having the Style Guide more exposed in the documentation.
I'm expecting to be able to reference it if people start asking for
things that would go against the guide. Also if anything I write that
follows the guide but isn't accessible then maybe I can contribute back
to the guide.
This commit is contained in:
Roger Steve Ruiz 2022-11-23 18:21:15 -05:00
parent 4b9a95361a
commit d1bdc84ab2
No known key found for this signature in database
GPG key ID: 68061DBF1C4C0B44

View file

@ -46,6 +46,25 @@ set -g @catppuccin_flavour 'latte' # or frappe, macchiato, mocha
1. Copy your desired theme's configuration contents into your Tmux config (usually stored at `~/.tmux.conf`)
2. Reload Tmux by either restarting the session or reloading it with `tmux source-file ~/.tmux.conf`
#### Configuration options
All flavours support certain levels of customization that match our [Catppuccin
Style Guide][style-guide]. To add these customizations, add any of the following
options to your Tmux configuration.
##### Enable window tabs
By default, the theme places the `window-status` in the `status-right`. With
`@catppuccin_window_tabs_enabled` set to `on`, the theme will place the
directory within the `status-right` and move the window names to the
`window-status` format variables.
```sh
set -g @catppuccin_window_tabs_enabled on # or off to disable window_tabs
```
[style-guide]: https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md
## 💝 Thanks to
- [Pocco81](https://github.com/catppuccin)