d1bdc84ab2
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.
78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
<h3 align="center">
|
|
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/>
|
|
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
|
|
Catppuccin for <a href="https://github.com/tmux/tmux">Tmux</a>
|
|
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
|
|
</h3>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/catppuccin/tmux/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/tmux?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
|
|
<a href="https://github.com/catppuccin/tmux/issues"><img src="https://img.shields.io/github/issues/catppuccin/tmux?colorA=363a4f&colorB=f5a97f&style=for-the-badge"></a>
|
|
<a href="https://github.com/catppuccin/tmux/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/tmux?colorA=363a4f&colorB=a6da95&style=for-the-badge"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src="./assets/preview.webp"/>
|
|
</p>
|
|
|
|
## Themes
|
|
|
|
- 🌻 [Latte](./catppuccin-latte.tmuxtheme)
|
|
- 🪴 [Frappé](./catppuccin-frappe.tmuxtheme)
|
|
- 🌺 [Macchiato](./catppuccin-macchiato.tmuxtheme)
|
|
- 🌿 [Mocha](./catppuccin-mocha.tmuxtheme)
|
|
|
|
## Usage
|
|
|
|
### TPM
|
|
|
|
1. Install [TPM](https://github.com/tmux-plugins/tpm)
|
|
2. Add the Catppuccin plugin:
|
|
|
|
```bash
|
|
set -g @plugin 'catppuccin/tmux'
|
|
# ...alongside
|
|
set -g @plugin 'tmux-plugins/tpm'
|
|
```
|
|
|
|
3. (Optional) Set your preferred flavour, it defaults to `"mocha"`:
|
|
|
|
```bash
|
|
set -g @catppuccin_flavour 'latte' # or frappe, macchiato, mocha
|
|
```
|
|
|
|
### Manual
|
|
|
|
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)
|
|
- [vinnyA3](https://github.com/vinnyA3)
|
|
- [rogeruiz](https://github.com/rogeruiz)
|
|
|
|
|
|
|
|
<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /></p>
|
|
<p align="center">Copyright © 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
|
|
<p align="center"><a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a></p>
|