122 lines
6.9 KiB
Markdown
122 lines
6.9 KiB
Markdown
# Zenbones
|
|
|
|
Zenbones is a collection of vim/neovim colorschemes designed to highlight code
|
|
using contrasts and font variations. Colors are tasked only for other roles such
|
|
as diagnostics, diffs, search matches.
|
|
|
|
It is carefully crafted for extensibility. You can
|
|
[create your own zenbones-based colorscheme](doc/zenbones.md#create-your-own-colorscheme)
|
|
or try the [built-in collection](#usage).
|
|
|
|
|
|
|
|
<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>
|
|
|
|
## Recommended setup
|
|
|
|
- Neovim with true colors support i.e. `set termguicolors`. Vim works but only
|
|
in compatibility mode.
|
|
- 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. Allows for more configuration or extending the colorscheme
|
|
requires = "rktjmp/lush.nvim"
|
|
-- If you don't want to install lush, make sure to set g:zenbones_compat = 1
|
|
}
|
|
```
|
|
|
|
## Usage
|
|
|
|
Just apply the colorscheme as usual:
|
|
|
|
```vim
|
|
set termguicolors
|
|
|
|
colorscheme zenbones " light
|
|
colorscheme zenflesh " dark
|
|
|
|
colorscheme zenwritten " Zero hue and saturation version
|
|
colorscheme neobones " https://neovim.io flavor
|
|
colorscheme vimbones " https://www.vim.org flavor
|
|
colorscheme rosebones " Rosé Pine flavor - https://rosepinetheme.com
|
|
colorscheme forestbones " Everforest flavor - https://github.com/sainnhe/everforest
|
|
colorscheme nordbones " Nord flavor - https://www.nordtheme.com/docs/colors-and-palettes
|
|
colorscheme tokyobones " Tokyo Night flavor - https://github.com/enkia/tokyo-night-vscode-theme#color-palette
|
|
```
|
|
|
|
## [Configuration and other documentations](doc/zenbones.md)
|
|
|
|
See [documentations](doc/zenbones.md) or `:help zenbones.txt`.
|
|
|
|
## Showcase
|
|
|
|
| Zenbones | Zenflesh |
|
|
| :------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: |
|
|
|  |  |
|
|
|  |  |
|
|
|
|
| 'bright' | default | 'dim' |
|
|
| :-----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
|
|
|  |  |  |
|
|
|
|
| 'stark' | default | 'warm' |
|
|
| :---------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
|
|
|  |  |  |
|
|
|
|
See more [showcase from the other flavors here](doc/showcase.md).
|
|
|
|
## 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)
|
|
- [Cmp](https://github.com/hrsh7th/nvim-cmp)
|
|
- [Neogit](https://github.com/TimUntersberger/neogit)
|
|
- [WhichKey](https://github.com/folke/which-key.nvim)
|
|
- [Trouble](https://github.com/folke/trouble.nvim)
|
|
- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
|
|
- [n³](https://github.com/mcchrish/nnn.vim)
|
|
|
|
## Other implementations
|
|
|
|
- [iTerm2](extras/iterm)
|
|
- [Kitty](extras/kitty)
|
|
- [Alacritty](extras/alacritty)
|
|
- [WezTerm](extras/wezterm)
|
|
- [Tmux](extras/tmux)
|
|
|
|
It's also possible to generate any color configuration files using a template,
|
|
[this one for Kitty](lua/zenbones/template/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).
|