2021-10-27 17:32:59 +08:00
|
|
|
# Zenbones
|
2021-02-07 20:43:35 +11:00
|
|
|
|
2021-11-03 16:27:58 +08:00
|
|
|
Zenbones is a collection of Vim/Neovim colorschemes designed to highlight code
|
2021-10-27 19:17:10 +08:00
|
|
|
using contrasts and font variations. Colors are tasked only for other roles such
|
|
|
|
|
as diagnostics, diffs, search matches.
|
2021-08-25 14:33:40 +08:00
|
|
|
|
2021-10-27 17:14:39 +08:00
|
|
|
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).
|
|
|
|
|
|
2021-11-02 18:53:57 +08:00
|
|
|
## ⚠️ Breaking change notice ⚠️
|
2021-11-02 18:51:58 +08:00
|
|
|
|
|
|
|
|
**zenflesh** is deprecated in favor of zenbones `background=dark`. It is
|
|
|
|
|
expected to be removed in the next release.
|
|
|
|
|
|
2021-11-03 13:36:52 +08:00
|
|
|
See all the
|
|
|
|
|
[changelogs in the release page](https://github.com/mcchrish/zenbones.nvim/releases).
|
|
|
|
|
|
2021-09-18 17:23:01 +08:00
|
|
|
|
2021-08-25 13:08:08 +08:00
|
|
|
|
|
|
|
|
<p align="center">
|
2021-08-26 15:50:06 +08:00
|
|
|
<em>A rock garden in <a href="https://en.wikipedia.org/wiki/Ry%C5%8Dan-ji">Ryōan-ji</a>.</em>
|
2021-08-25 13:08:08 +08:00
|
|
|
</p>
|
|
|
|
|
|
2021-09-26 16:21:27 +08:00
|
|
|
## Recommended setup
|
2021-08-25 13:55:53 +08:00
|
|
|
|
2021-10-20 16:21:06 +08:00
|
|
|
- Neovim with true colors support i.e. `set termguicolors`. Vim works but only
|
|
|
|
|
in compatibility mode.
|
2021-08-27 16:22:07 +08:00
|
|
|
- Font with bold and italic
|
|
|
|
|
- Terminal or GUI with bold and italic support
|
2021-08-25 13:55:53 +08:00
|
|
|
|
2021-08-26 15:45:06 +08:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
Example installation using packer:
|
|
|
|
|
|
|
|
|
|
```lua
|
2021-10-10 14:27:37 +08:00
|
|
|
use {
|
|
|
|
|
"mcchrish/zenbones.nvim",
|
|
|
|
|
-- Optionally install Lush. Allows for more configuration or extending the colorscheme
|
|
|
|
|
requires = "rktjmp/lush.nvim"
|
2021-10-10 19:23:08 +08:00
|
|
|
-- If you don't want to install lush, make sure to set g:zenbones_compat = 1
|
2021-10-10 14:27:37 +08:00
|
|
|
}
|
2021-08-26 15:45:06 +08:00
|
|
|
```
|
|
|
|
|
|
2021-08-25 14:44:32 +08:00
|
|
|
## Usage
|
|
|
|
|
|
2021-08-26 15:50:06 +08:00
|
|
|
Just apply the colorscheme as usual:
|
2021-08-25 14:44:32 +08:00
|
|
|
|
|
|
|
|
```vim
|
2021-10-27 17:14:39 +08:00
|
|
|
set termguicolors
|
2021-11-04 06:16:29 +08:00
|
|
|
set background=light " or dark
|
2021-10-27 17:14:39 +08:00
|
|
|
|
2021-11-01 17:06:22 +08:00
|
|
|
colorscheme zenbones
|
2021-09-21 19:29:37 +08:00
|
|
|
|
2021-10-27 17:14:39 +08:00
|
|
|
colorscheme zenwritten " Zero hue and saturation version
|
|
|
|
|
colorscheme neobones " https://neovim.io flavor
|
2021-10-31 08:34:57 +08:00
|
|
|
colorscheme vimbones " https://www.vim.org flavor
|
2021-10-27 17:14:39 +08:00
|
|
|
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
|
2021-08-25 14:44:32 +08:00
|
|
|
```
|
|
|
|
|
|
2021-09-18 16:20:54 +08:00
|
|
|
## [Configuration and other documentations](doc/zenbones.md)
|
2021-08-30 09:34:39 +08:00
|
|
|
|
2021-09-18 16:20:54 +08:00
|
|
|
See [documentations](doc/zenbones.md) or `:help zenbones.txt`.
|
2021-08-31 10:46:42 +08:00
|
|
|
|
2021-09-18 16:07:20 +08:00
|
|
|
## Showcase
|
2021-08-30 09:34:39 +08:00
|
|
|
|
2021-11-01 17:06:22 +08:00
|
|
|
| light | dark |
|
2021-09-18 16:46:09 +08:00
|
|
|
| :------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: |
|
|
|
|
|
|  |  |
|
|
|
|
|
|  |  |
|
|
|
|
|
|
2021-09-18 16:20:54 +08:00
|
|
|
| 'bright' | default | 'dim' |
|
2021-09-16 20:19:48 +08:00
|
|
|
| :-----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
|
2021-09-17 19:42:21 +08:00
|
|
|
|  |  |  |
|
2021-08-30 09:34:39 +08:00
|
|
|
|
2021-09-18 16:20:54 +08:00
|
|
|
| 'stark' | default | 'warm' |
|
2021-09-17 19:44:55 +08:00
|
|
|
| :---------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
|
2021-09-17 19:42:21 +08:00
|
|
|
|  |  |  |
|
2021-08-30 09:34:39 +08:00
|
|
|
|
2021-10-31 08:59:37 +08:00
|
|
|
See more [showcase from the other flavors here](doc/showcase.md).
|
2021-10-20 18:02:20 +08:00
|
|
|
|
2021-08-25 15:34:38 +08:00
|
|
|
## Other plugins support
|
2021-08-25 14:33:40 +08:00
|
|
|
|
2021-09-04 17:48:42 +08:00
|
|
|
Aside from LSP and basic Tree-sitter support, here are some plugins that are
|
|
|
|
|
currently supported.
|
2021-08-25 14:33:40 +08:00
|
|
|
|
2021-08-29 10:59:04 +08:00
|
|
|
- [Git Signs](https://github.com/lewis6991/gitsigns.nvim)
|
2021-09-03 11:19:05 +08:00
|
|
|
- [Git Gutter](https://github.com/airblade/vim-gitgutter)
|
2021-08-29 10:59:04 +08:00
|
|
|
- [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
|
2021-08-27 16:22:07 +08:00
|
|
|
- [Telescope](https://github.com/nvim-telescope/telescope.nvim)
|
2021-08-29 10:59:04 +08:00
|
|
|
- [Sneak](https://github.com/justinmk/vim-sneak)
|
2021-09-06 12:33:15 +08:00
|
|
|
- [Lightspeed](https://github.com/ggandor/lightspeed.nvim)
|
2021-09-06 12:56:58 +08:00
|
|
|
- [Hop](https://github.com/phaazon/hop.nvim)
|
2021-09-04 17:02:39 +08:00
|
|
|
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
|
2021-09-06 13:54:38 +08:00
|
|
|
- [Lightline](https://github.com/itchyny/lightline.vim)
|
2021-08-29 10:59:04 +08:00
|
|
|
- [BarBar](https://github.com/romgrk/barbar.nvim)
|
|
|
|
|
- [CoC](https://github.com/neoclide/coc.nvim)
|
2021-10-23 18:07:52 +08:00
|
|
|
- [Cmp](https://github.com/hrsh7th/nvim-cmp)
|
2021-08-29 10:59:04 +08:00
|
|
|
- [Neogit](https://github.com/TimUntersberger/neogit)
|
2021-09-05 17:39:39 +08:00
|
|
|
- [WhichKey](https://github.com/folke/which-key.nvim)
|
2021-09-10 16:35:00 +08:00
|
|
|
- [Trouble](https://github.com/folke/trouble.nvim)
|
2021-09-25 17:45:16 +08:00
|
|
|
- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
|
2021-10-29 17:00:45 +08:00
|
|
|
- [n³](https://github.com/mcchrish/nnn.vim)
|
2021-08-25 14:33:40 +08:00
|
|
|
|
2021-08-24 18:32:29 +08:00
|
|
|
## Other implementations
|
|
|
|
|
|
2021-09-17 19:44:55 +08:00
|
|
|
- [iTerm2](extras/iterm)
|
|
|
|
|
- [Kitty](extras/kitty)
|
|
|
|
|
- [Alacritty](extras/alacritty)
|
|
|
|
|
- [WezTerm](extras/wezterm)
|
|
|
|
|
- [Tmux](extras/tmux)
|
2021-08-25 14:33:40 +08:00
|
|
|
|
2021-09-25 07:31:15 +08:00
|
|
|
It's also possible to generate any color configuration files using a template,
|
2021-09-26 16:21:27 +08:00
|
|
|
[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.
|
2021-09-04 17:48:42 +08:00
|
|
|
|
2021-08-25 14:33:40 +08:00
|
|
|
## Inspirations
|
|
|
|
|
|
|
|
|
|
Zenbones is heavily inspired by
|
2021-08-25 16:54:14 +08:00
|
|
|
[Verdandi](https://github.com/be5invis/vsc-theme-verdandi) and
|
2021-08-25 15:49:45 +08:00
|
|
|
[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).
|
|
|
|
|
|
2021-08-25 16:16:56 +08:00
|
|
|
There are more similar
|
2021-08-25 15:49:45 +08:00
|
|
|
[colorschemes with few colors from this collection](https://github.com/mcchrish/vim-no-color-collections).
|
