204 lines
5.8 KiB
Markdown
204 lines
5.8 KiB
Markdown
# Zenbones
|
|
|
|
Zenbones is a light vim/neovim
|
|
[colorscheme](https://neovim.io/doc/user/syntax.html#:colorscheme) designed to
|
|
highlight code using contrasts and font variations. Colors are tasked only for
|
|
other roles such as diagnostics, diffs, search matches.
|
|
|
|
<!-- panvimdoc-ignore-start -->
|
|
|
|
|
|
|
|
<p align="center">
|
|
<em>A rock garden in <a href="https://en.wikipedia.org/wiki/Ry%C5%8Dan-ji">Ryōan-ji</a>.</em>
|
|
</p>
|
|
|
|
<!-- panvimdoc-ignore-end -->
|
|
|
|
## Requirements
|
|
|
|
Primarily built for neovim but it works pretty well with vim. However here are
|
|
some requirements to take full advantage of the colorscheme:
|
|
|
|
- 24-bit RGB colors (neovim or vim compiled with +termguicolors)
|
|
- Font with bold and italic
|
|
- Terminal or GUI with bold and italic support
|
|
|
|
## Installation
|
|
|
|
Example installation using packer:
|
|
|
|
```lua
|
|
use "mcchrish/zenbones.nvim"
|
|
|
|
-- Optionally install Lush. Useful if you want to extend the theme
|
|
-- e.g. create a statusline plugin theme using zenbones colors
|
|
use "rktjmp/lush.nvim"
|
|
-- See Advanced Usage section for more details
|
|
```
|
|
|
|
## Usage
|
|
|
|
Just apply the colorscheme as usual:
|
|
|
|
```vim
|
|
set termguicolors
|
|
colorscheme zenbones
|
|
```
|
|
|
|
If you want to make use of the lua version:
|
|
|
|
```vim
|
|
" has('nvim') only
|
|
set termguicolors
|
|
colorscheme zenbones-lush
|
|
```
|
|
|
|
It works pretty much the same as the first one but pretty handy when extending
|
|
or customizing the colors to your likings.
|
|
|
|
<!-- panvimdoc-ignore-start -->
|
|
|
|
## Showcase
|
|
|
|
**Diff highlights**
|
|
|
|
<img width="1080" alt="Vim diff" src="https://user-images.githubusercontent.com/7200153/131212101-3a3b4083-f3ae-4dfc-ab1f-133cf3600a01.png">
|
|
|
|
**Search matches**
|
|
|
|
<img width="1080" alt="Search matches" src="https://user-images.githubusercontent.com/7200153/131212102-620323dc-01db-4e40-ae74-640a00368121.png">
|
|
|
|
**LSP diagnostics**
|
|
|
|
<img width="1080" alt="LSP diagnostics" src="https://user-images.githubusercontent.com/7200153/131212106-b515ba76-d157-46b3-b1cb-c72811abbff3.png">
|
|
|
|
_Font used is [Iosevka Curly Slab](https://typeof.net/Iosevka/)_.
|
|
|
|
<!-- panvimdoc-ignore-end -->
|
|
|
|
## Configuration
|
|
|
|
Configuration is only available for `zenbones-lush`.
|
|
|
|
#### g:zenbones_lightness
|
|
|
|
Change background colors lightness.
|
|
|
|
**'bright'**
|
|
|
|
<img width="1080" alt="Bright lightness" src="https://user-images.githubusercontent.com/7200153/131272384-710e253f-059d-46fd-bf0e-7d82f62d62cd.png">
|
|
|
|
**Default** _(unset)_
|
|
|
|
<img width="1080" alt="Default lightness" src="https://user-images.githubusercontent.com/7200153/131272333-3fb67e68-fcd2-48ae-b8c4-ab24b701ed5e.png">
|
|
|
|
**'dim'**
|
|
|
|
<img width="1080" alt="Dim lightness" src="https://user-images.githubusercontent.com/7200153/131272410-329636bb-fd8e-42fb-83aa-f436d211b5ed.png">
|
|
|
|
#### g:zenbones_solid_vert_split
|
|
|
|
Set to `v:true` to make vertical split more visible with a dimmer background
|
|
highlight.
|
|
|
|
#### g:zenbones_dim_noncurrent_window
|
|
|
|
Set to `v:true` to make non-current window background dimmer than _Normal_.
|
|
|
|
## Advanced Usage
|
|
|
|
Zenbones is pretty extensible thanks to
|
|
[Lush](https://github.com/rktjmp/lush.nvim). You can easily retrieve the colors
|
|
in lua:
|
|
|
|
```lua
|
|
local theme = require "zenbones"
|
|
local colors = require "zenbones.colors"
|
|
|
|
print(theme.StatusLine.bg.hex)
|
|
print(sand.darken(20).hex)
|
|
```
|
|
|
|
See also
|
|
[Lush's documentation](https://github.com/rktjmp/lush.nvim#advanced-usage) for
|
|
the complete options.
|
|
|
|
## Other plugins support
|
|
|
|
Aside from LSP and basic Tree-sitter support, here are some plugins that are
|
|
currently supported.
|
|
|
|
- [Git Signs](https://github.com/lewis6991/gitsigns.nvim)
|
|
- [Git Gutter](https://github.com/airblade/vim-gitgutter)
|
|
- [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
|
|
- [Telescope](https://github.com/nvim-telescope/telescope.nvim)
|
|
- [Sneak](https://github.com/justinmk/vim-sneak)
|
|
- [Lightspeed](https://github.com/ggandor/lightspeed.nvim)
|
|
- [Hop](https://github.com/phaazon/hop.nvim)
|
|
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
|
|
- [Lightline](https://github.com/itchyny/lightline.vim)
|
|
- [BarBar](https://github.com/romgrk/barbar.nvim)
|
|
- [CoC](https://github.com/neoclide/coc.nvim)
|
|
- [Neogit](https://github.com/TimUntersberger/neogit)
|
|
- [WhichKey](https://github.com/folke/which-key.nvim)
|
|
|
|
## Other implementations
|
|
|
|
- [iTerm2](extras/iterm/zenbones.itermcolors)
|
|
- [Kitty](extras/kitty/zenbones.conf)
|
|
- [Alacritty](extras/alacritty/zenbones.yml)
|
|
- [WezTerm](extras/wezterm/Zenbones.toml)
|
|
|
|
### Print terminal colors
|
|
|
|
You can retrieve the terminal colors by using this command:
|
|
|
|
```vim
|
|
:lua require("zenbones.print").print_terminal_colors()
|
|
```
|
|
|
|
Useful when you want to apply a zenbones theme to your terminal. Recent output:
|
|
|
|
```
|
|
Terminal colors
|
|
foreground: #2C363C
|
|
background: #F0EDEC
|
|
ansi color0: #2C363C
|
|
ansi color1: #A8334C
|
|
ansi color2: #617437
|
|
ansi color3: #944927
|
|
ansi color4: #286486
|
|
ansi color5: #88507D
|
|
ansi color6: #3B8992
|
|
ansi color7: #F0EDEC
|
|
ansi color8: #44525B
|
|
ansi color9: #9C2842
|
|
ansi color10: #55672A
|
|
ansi color11: #87411E
|
|
ansi color12: #1F5A7A
|
|
ansi color13: #864079
|
|
ansi color14: #2F7C85
|
|
ansi color15: #DCD2CE
|
|
cursor foreground: #F2F0EF
|
|
cursor background: #2C363C
|
|
inactive cursor foreground: #F2F0EF
|
|
inactive cursor background: #4D5C65
|
|
selection background: #D2DFE7
|
|
```
|
|
|
|
It's also possible to generate color configuration files using a template,
|
|
[this one for Kitty](lua/zenbones/build/kitty.lua) for example. Please feel free
|
|
to submit a PR if you want to add some more.
|
|
|
|
## Inspirations
|
|
|
|
Zenbones is heavily inspired by
|
|
[Verdandi](https://github.com/be5invis/vsc-theme-verdandi) and
|
|
[vim-yin-yang](https://github.com/pgdouyon/vim-yin-yang). The name came from a
|
|
book called
|
|
[Zen Flesh, Zen Bones](https://en.wikipedia.org/wiki/Zen_Flesh,_Zen_Bones).
|
|
|
|
There are more similar
|
|
[colorschemes with few colors from this collection](https://github.com/mcchrish/vim-no-color-collections).
|