README.md

# Zenflesh, Zenbones

Zenbones is a vim/neovim colorscheme designed to highlight code using contrasts
and font variations. Colors are tasked only for other roles such as diagnostics,
diffs, search matches.

![Zenbones main image](https://user-images.githubusercontent.com/7200153/133883977-116795f3-c602-45f0-8907-b89c8d0b2f82.jpg)

<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

-   Vim/Neovim with true colors support i.e. `set 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
colorscheme zenbones " light
colorscheme zenflesh " dark
```

If you want to make use of the lua version:

```vim
" Requires `neovim` and `rktjmp/lush.nvim` installed
colorscheme zenbones-lush
colorscheme zenflesh-lush

" https://neovim.io flavor
colorscheme neobones
" Rosé Pine flavor - https://rosepinetheme.com
colorscheme rosebones
```

## [Configuration and other documentations](doc/zenbones.md)

See [documentations](doc/zenbones.md) or `:help zenbones.txt`.

## Showcase

|                                                       Zenbones                                                       |                                                       Zenflesh                                                       |
| :------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: |
|    ![diff](https://user-images.githubusercontent.com/7200153/133882734-de14cbb7-2faa-431b-9cb4-d674bf0f1d6a.png)     |    ![diff](https://user-images.githubusercontent.com/7200153/133882728-69abeca4-65d2-44e9-bddb-955e871c3143.png)     |
| ![diagnostics](https://user-images.githubusercontent.com/7200153/133882735-974ce339-1d5e-4bc0-9a95-82d21934222b.png) | ![diagnostics](https://user-images.githubusercontent.com/7200153/133882738-1b11be5f-5885-4ff9-9670-7e0bacbb6dd8.png) |

|                                                         'bright'                                                          |                                                          default                                                           |                                                         'dim'                                                          |
| :-----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
| ![Bright lightness](https://user-images.githubusercontent.com/7200153/133776552-5919f664-17d9-4d96-bf44-d587f20b01dc.png) | ![Default lightness](https://user-images.githubusercontent.com/7200153/133776625-d8e9dd88-13b3-4362-9cad-2031ef6ccf7d.png) | ![Dim lightness](https://user-images.githubusercontent.com/7200153/133776674-ff7d15e9-52e3-4a27-9099-722ffcbe1cb8.png) |

|                                                         'stark'                                                         |                                                          default                                                          |                                                         'warm'                                                         |
| :---------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
| ![Stark darkness](https://user-images.githubusercontent.com/7200153/133776839-4b12c3dd-233f-47d1-9740-006bf50e812a.png) | ![Default darkness](https://user-images.githubusercontent.com/7200153/133776882-26d006b4-50db-49ad-bd79-3bec327a95fc.png) | ![Warm darkness](https://user-images.githubusercontent.com/7200153/133776957-3d2949c9-51b6-4537-aca4-6ced80113b91.png) |

## 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)
-   [Trouble](https://github.com/folke/trouble.nvim)
-   [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)

## 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).
reverse terminal white and black 2021-09-14 16:07:08 +08:00			`# Zenflesh, Zenbones`
Add base template files 2021-02-07 20:43:35 +11:00
update config 2021-09-16 20:19:48 +08:00			`Zenbones is a vim/neovim colorscheme designed to highlight code using contrasts`
			`and font variations. Colors are tasked only for other roles such as diagnostics,`
			`diffs, search matches.`
more readme 2021-08-25 14:33:40 +08:00
update main image 2021-09-18 17:23:01 +08:00			`![Zenbones main image](https://user-images.githubusercontent.com/7200153/133883977-116795f3-c602-45f0-8907-b89c8d0b2f82.jpg)`
add main photo 2021-08-25 13:08:08 +08:00
			`<p align="center">`
improve usage section 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>`
add main photo 2021-08-25 13:08:08 +08:00			`</p>`

update requirements 2021-09-26 16:21:27 +08:00			`## Recommended setup`
add requirements 2021-08-25 13:55:53 +08:00
update requirements 2021-09-26 16:21:27 +08:00			- Vim/Neovim with true colors support i.e. `set termguicolors`
link to neovim doc 2021-08-27 16:22:07 +08:00			`- Font with bold and italic`
			`- Terminal or GUI with bold and italic support`
add requirements 2021-08-25 13:55:53 +08:00
add installation section 2021-08-26 15:45:06 +08:00			`## Installation`

			`Example installation using packer:`

			```lua
			`use "mcchrish/zenbones.nvim"`

finish docs 2021-08-26 16:12:43 +08:00			`-- Optionally install Lush. Useful if you want to extend the theme`
add installation section 2021-08-26 15:45:06 +08:00			`-- e.g. create a statusline plugin theme using zenbones colors`
			`use "rktjmp/lush.nvim"`
finish docs 2021-08-26 16:12:43 +08:00			`-- See Advanced Usage section for more details`
add installation section 2021-08-26 15:45:06 +08:00			```

add usage 2021-08-25 14:44:32 +08:00			`## Usage`

improve usage section 2021-08-26 15:50:06 +08:00			`Just apply the colorscheme as usual:`
add usage 2021-08-25 14:44:32 +08:00
			```vim
update links 2021-09-17 19:44:55 +08:00			`colorscheme zenbones " light`
			`colorscheme zenflesh " dark`
add usage 2021-08-25 14:44:32 +08:00			```

fix readme order 2021-09-05 09:22:56 +08:00			`If you want to make use of the lua version:`
add usage 2021-08-25 14:44:32 +08:00
			```vim
simplify readme 2021-09-11 13:22:19 +08:00			" Requires `neovim` and `rktjmp/lush.nvim` installed
zenbones-lua -> zenbones-lush 2021-08-27 05:36:21 +08:00			`colorscheme zenbones-lush`
update config 2021-09-16 20:19:48 +08:00			`colorscheme zenflesh-lush`
add colorscheme neovim instruction 2021-09-21 19:29:37 +08:00
add rosebones a rose pine flavor 2021-10-04 15:44:31 +08:00			`" https://neovim.io flavor`
neovim -> neobones 2021-10-09 17:30:15 +08:00			`colorscheme neobones`
add rosebones a rose pine flavor 2021-10-04 15:44:31 +08:00			`" Rosé Pine flavor - https://rosepinetheme.com`
			`colorscheme rosebones`
add usage 2021-08-25 14:44:32 +08:00			```

add doc link 2021-09-18 16:20:54 +08:00			`## [Configuration and other documentations](doc/zenbones.md)`
document lightness config 2021-08-30 09:34:39 +08:00
add doc link 2021-09-18 16:20:54 +08:00			See [documentations](doc/zenbones.md) or `:help zenbones.txt`.
configuration is only available for zenbones-lush 2021-08-31 10:46:42 +08:00
separate docs file and auto-generation 2021-09-18 16:07:20 +08:00			`## Showcase`
document lightness config 2021-08-30 09:34:39 +08:00
add more showcase 2021-09-18 16:46:09 +08:00			`\| Zenbones \| Zenflesh \|`
			`\| :------------------------------------------------------------------------------------------------------------------: \| :------------------------------------------------------------------------------------------------------------------: \|`
			`\| ![diff](https://user-images.githubusercontent.com/7200153/133882734-de14cbb7-2faa-431b-9cb4-d674bf0f1d6a.png) \| ![diff](https://user-images.githubusercontent.com/7200153/133882728-69abeca4-65d2-44e9-bddb-955e871c3143.png) \|`
			`\| ![diagnostics](https://user-images.githubusercontent.com/7200153/133882735-974ce339-1d5e-4bc0-9a95-82d21934222b.png) \| ![diagnostics](https://user-images.githubusercontent.com/7200153/133882738-1b11be5f-5885-4ff9-9670-7e0bacbb6dd8.png) \|`

add doc link 2021-09-18 16:20:54 +08:00			`\| 'bright' \| default \| 'dim' \|`
update config 2021-09-16 20:19:48 +08:00			`\| :-----------------------------------------------------------------------------------------------------------------------: \| :------------------------------------------------------------------------------------------------------------------------: \| :--------------------------------------------------------------------------------------------------------------------: \|`
update screenshots 2021-09-17 19:42:21 +08:00			`\| ![Bright lightness](https://user-images.githubusercontent.com/7200153/133776552-5919f664-17d9-4d96-bf44-d587f20b01dc.png) \| ![Default lightness](https://user-images.githubusercontent.com/7200153/133776625-d8e9dd88-13b3-4362-9cad-2031ef6ccf7d.png) \| ![Dim lightness](https://user-images.githubusercontent.com/7200153/133776674-ff7d15e9-52e3-4a27-9099-722ffcbe1cb8.png) \|`
document lightness config 2021-08-30 09:34:39 +08:00
add doc link 2021-09-18 16:20:54 +08:00			`\| 'stark' \| default \| 'warm' \|`
update links 2021-09-17 19:44:55 +08:00			`\| :---------------------------------------------------------------------------------------------------------------------: \| :-----------------------------------------------------------------------------------------------------------------------: \| :--------------------------------------------------------------------------------------------------------------------: \|`
update screenshots 2021-09-17 19:42:21 +08:00			`\| ![Stark darkness](https://user-images.githubusercontent.com/7200153/133776839-4b12c3dd-233f-47d1-9740-006bf50e812a.png) \| ![Default darkness](https://user-images.githubusercontent.com/7200153/133776882-26d006b4-50db-49ad-bd79-3bec327a95fc.png) \| ![Warm darkness](https://user-images.githubusercontent.com/7200153/133776957-3d2949c9-51b6-4537-aca4-6ced80113b91.png) \|`
document lightness config 2021-08-30 09:34:39 +08:00
improve read me 2021-08-25 15:34:38 +08:00			`## Other plugins support`
more readme 2021-08-25 14:33:40 +08:00
mention config templates 2021-09-04 17:48:42 +08:00			`Aside from LSP and basic Tree-sitter support, here are some plugins that are`
			`currently supported.`
more readme 2021-08-25 14:33:40 +08:00
update readme 2021-08-29 10:59:04 +08:00			`- [Git Signs](https://github.com/lewis6991/gitsigns.nvim)`
add git gutter 2021-09-03 11:19:05 +08:00			`- [Git Gutter](https://github.com/airblade/vim-gitgutter)`
update readme 2021-08-29 10:59:04 +08:00			`- [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)`
link to neovim doc 2021-08-27 16:22:07 +08:00			`- [Telescope](https://github.com/nvim-telescope/telescope.nvim)`
update readme 2021-08-29 10:59:04 +08:00			`- [Sneak](https://github.com/justinmk/vim-sneak)`
add lightspeed support 2021-09-06 12:33:15 +08:00			`- [Lightspeed](https://github.com/ggandor/lightspeed.nvim)`
add hop support 2021-09-06 12:56:58 +08:00			`- [Hop](https://github.com/phaazon/hop.nvim)`
remove lush requirement for lualine 2021-09-04 17:02:39 +08:00			`- [Lualine](https://github.com/hoob3rt/lualine.nvim)`
add lightline support 2021-09-06 13:54:38 +08:00			`- [Lightline](https://github.com/itchyny/lightline.vim)`
update readme 2021-08-29 10:59:04 +08:00			`- [BarBar](https://github.com/romgrk/barbar.nvim)`
			`- [CoC](https://github.com/neoclide/coc.nvim)`
			`- [Neogit](https://github.com/TimUntersberger/neogit)`
add WhichKey 2021-09-05 17:39:39 +08:00			`- [WhichKey](https://github.com/folke/which-key.nvim)`
add Trouble support 2021-09-10 16:35:00 +08:00			`- [Trouble](https://github.com/folke/trouble.nvim)`
support nvim-tree 2021-09-25 17:45:16 +08:00			`- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)`
more readme 2021-08-25 14:33:40 +08:00
initial readme 2021-08-24 18:32:29 +08:00			`## Other implementations`

update links 2021-09-17 19:44:55 +08:00			`- [iTerm2](extras/iterm)`
			`- [Kitty](extras/kitty)`
			`- [Alacritty](extras/alacritty)`
			`- [WezTerm](extras/wezterm)`
			`- [Tmux](extras/tmux)`
more readme 2021-08-25 14:33:40 +08:00
fix doc links 2021-09-25 07:31:15 +08:00			`It's also possible to generate any color configuration files using a template,`
update requirements 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.`
mention config templates 2021-09-04 17:48:42 +08:00
more readme 2021-08-25 14:33:40 +08:00			`## Inspirations`

			`Zenbones is heavily inspired by`
vervandi -> verdandi 2021-08-25 16:54:14 +08:00			`[Verdandi](https://github.com/be5invis/vsc-theme-verdandi) and`
improve inspiration section 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).`

improve description 2021-08-25 16:16:56 +08:00			`There are more similar`
improve inspiration section 2021-08-25 15:49:45 +08:00			`[colorschemes with few colors from this collection](https://github.com/mcchrish/vim-no-color-collections).`