4f8b69ab8b
* feat: define dark and light color palettes * feat: add customization of status-right & status-left sections * feat: rename to gruvbox_dark256 and implement alpha option * fix: transparency for tabs in left status bar * fix: shellcheck errors * fix: files according to shfmt * feat: remove unnecessary modeline * feat: save palettes as 256 color * feat: update information about dark256 & light256 themes * chore: add changelog entry
173 lines
4.5 KiB
Markdown
173 lines
4.5 KiB
Markdown
<div align="center">
|
|
<img src="./docs/assets/img/logo-v1@0.5x.png" width="200px">
|
|
<h1>Gruvbox theme for Tmux</h1>
|
|
</div>
|
|
|
|
Theme with 'retro groove' flavor for [Tmux][github-tmux], based on Pavel Pertsev's [gruvbox colorscheme][github-grovbox] and inspired by work of [Gordon Chiam](https://gist.github.com/gchiam/4606522f513cc64b79ce). Subthemes switching inspired by [tmux-color-solarized][tmux-color-solarized].
|
|
|
|
<!--
|
|
Using HTML table instead default markdown tables as provide it provide
|
|
much better code readability especially for long columns.
|
|
-->
|
|
|
|
<div align="center">
|
|
<a href="./docs/assets/img/gruvbox-dark-and-light-theme-structure.png" title="Grovbox dark and light themes for Tmux">
|
|
<img src="./docs/assets/img/gruvbox-dark-and-light-theme-structure@0.5x.png"
|
|
title="Grovbox dark and light themes for Tmux"
|
|
width="100%"
|
|
height="auto"
|
|
style="max-width: 800px; text-align: center; border-radius: 12px; overflow:hidden;" />
|
|
</a>
|
|
</div>
|
|
|
|
> Screenshot made from macOS [alacritty][github-alacritty] terminal with xterm-256color and [Hack Nerd Font Regular][github-nerd-fonts].<br/>
|
|
> Backgrounds by [Aleksandar Pasaric][pexcel-1] and [Vishnu Murali][pexcel-2].
|
|
|
|
## Installation
|
|
|
|
### Install via [TPM][github-tpm] (recommended)
|
|
|
|
Add plugin at the top list of TPM plugins in `.tmux.conf` and select desired theme.
|
|
|
|
```bash
|
|
# ~/.tmux.conf
|
|
set -g @plugin 'egel/tmux-gruvbox'
|
|
# set desired options...
|
|
set -g @tmux-gruvbox 'dark' # or 'light'
|
|
```
|
|
|
|
Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated with the theme at this point.
|
|
|
|
### Install manually
|
|
|
|
1. Clone the project to desired location
|
|
|
|
> ![TIP] If you do not have github account [download](https://github.com/egel/tmux-gruvbox/archive/refs/heads/main.zip) it and unzip.
|
|
|
|
```bash
|
|
cd ~/projects/
|
|
git clone ...
|
|
```
|
|
|
|
1. Add theme at to top of your `~/.tmux.conf` config.
|
|
|
|
```bash
|
|
# ~/.tmux.conf
|
|
run ~/projects/tmux-gruvbox/tmux-gruvbox.tmux
|
|
# set desired options...
|
|
set -g @tmux-gruvbox 'dark' # or light
|
|
```
|
|
|
|
## Configuration options
|
|
|
|
### Theme
|
|
|
|
- default value: `dark256`
|
|
- available themes:
|
|
- [`dark256`](./docs/assets/img/gruvbox-dark-theme.png)
|
|
- [`light256`](./docs/assets/img/gruvbox-light-theme.png)
|
|
|
|
```bash
|
|
set -g @tmux-gruvbox 'dark256'
|
|
```
|
|
|
|
### Transparent status-bar
|
|
|
|
- default value: `'false'`
|
|
- tmux >= 3.2 (experimental)
|
|
|
|
```bash
|
|
set -g @tmux-gruvbox-statusbar-alpha 'true'
|
|
```
|
|
|
|
### Left Status (Section A)
|
|
|
|
- default value: `'#S'`
|
|
|
|
```bash
|
|
set -g @tmux-gruvbox-left-status-a
|
|
```
|
|
|
|
### Right Status (Section X)
|
|
|
|
- default value: `'%Y-%m-%d'`
|
|
|
|
This section is customizable for user, and by default contains current date.
|
|
|
|
```bash
|
|
set -g @tmux-gruvbox-right-status-x
|
|
```
|
|
|
|
### Right Status (Section Y)
|
|
|
|
- default value: `'%H:%M'`
|
|
|
|
This section is customizable for user, and by default contains current time.
|
|
|
|
```bash
|
|
# set different time format
|
|
set -g @tmux-gruvbox-right-status-y '%H:%M'
|
|
```
|
|
|
|
### Right Status (Section Z)
|
|
|
|
- default value: `'#h'`
|
|
|
|
This section is customizable for user, and by default contains hostname.
|
|
|
|
```bash
|
|
# enhance this section with other plugin
|
|
set -g @tmux-gruvbox-right-status-z '#h #{tmux_mode_indicator} '
|
|
```
|
|
|
|
## Development
|
|
|
|
To run project locally:
|
|
|
|
1. clone the repository to desired place
|
|
|
|
```bash
|
|
cd $HOME/projects/
|
|
git clone ...
|
|
```
|
|
|
|
1. create a symlink to the cloned repository (best in the standard [TPM][github-tpm] plugin directory):
|
|
|
|
```bash
|
|
# cd to tmux plugin directory
|
|
cd ~/.tmux/plugins/
|
|
|
|
# create symlink to cloned repo
|
|
ln -sf $HOME/projects/tmux-gruvbox/ tmux-gruvbox
|
|
```
|
|
|
|
1. and in `~/.tmux.conf` set
|
|
|
|
```bash
|
|
# ~/.tmux.conf
|
|
set -g @plugin 'egel/tmux-gruvbox'
|
|
# set desired options...
|
|
set -g @tmux-gruvbox 'dark'
|
|
```
|
|
|
|
### Linters & formatters
|
|
|
|
To keep the files clean we use few program to help us achieve it:
|
|
|
|
1. Editorconfig (make sure your editor have it)
|
|
2. Markdown (prettier/prettierd)
|
|
3. Shell (shellcheck, shfmt)
|
|
|
|
## License
|
|
|
|
GPLv3 - Maciej Sypień
|
|
|
|
[github-tmux]: https://github.com/tmux/tmux
|
|
[github-grovbox]: https://github.com/morhetz/gruvbox
|
|
[github-hack]: https://github.com/chrissimpkins/Hack
|
|
[github-nerd-fonts]: https://github.com/ryanoasis/nerd-fonts
|
|
[github-alacritty]: https://github.com/alacritty/alacritty
|
|
[github-tpm]: https://github.com/tmux-plugins/tpm
|
|
[tmux-color-solarized]: https://github.com/seebi/tmux-colors-solarized
|
|
[pexcel-1]: https://www.pexels.com/photo/urban-photo-of-an-alley-2411688/
|
|
[pexcel-2]: https://www.pexels.com/photo/lights-hanging-above-the-alley-in-a-city-at-night-27044195/
|