finn/zenbones-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
30d9598356588bde64c4a29eb56aa241a246108c
zenbones-theme/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

136 lines
8.3 KiB
Markdown
Raw Normal View History

simplify title
2021-10-27 17:32:59 +08:00
# Zenbones
Add base template files
2021-02-07 20:43:35 +11:00
update docs
2021-11-16 08:52:22 +08:00
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.
more readme
2021-08-25 14:33:40 +08:00
improve readme
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).
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
not vim compatibility mode
2021-10-20 16:21:06 +08:00
- Neovim with true colors support i.e. `set termguicolors`. Vim works but only
in compatibility mode.
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
update install and config doc
2021-10-10 14:27:37 +08:00
use {
"mcchrish/zenbones.nvim",
-- Optionally install Lush. Allows for more configuration or extending the colorscheme
document zenbones_compat
2021-10-10 19:23:08 +08:00
-- If you don't want to install lush, make sure to set g:zenbones_compat = 1
doc: add notice about compat mode in Vim
2021-11-06 14:37:35 +08:00
-- In Vim, compat mode is turned on as Lush only works in Neovim.
Merge branch 'main' into refactor-build Conflicts: README.md autoload/zenbones_dark.vim colors/zenbones.vim doc/zenbones.md lua/zenflesh/init.lua
2021-11-04 10:06:35 +08:00
requires = "rktjmp/lush.nvim"
update install and config doc
2021-10-10 14:27:37 +08:00
}
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
improve readme
2021-10-27 17:14:39 +08:00
set termguicolors
doc: add set background instruction
2021-11-04 06:16:29 +08:00
set background=light " or dark
improve readme
2021-10-27 17:14:39 +08:00
doc: remove mention of zenflesh
2021-11-01 17:06:22 +08:00
colorscheme zenbones
add usage
2021-08-25 14:44:32 +08:00
```
document collection as table
2021-11-04 18:06:47 +08:00
Or choose from the collection:
add kanagawabones
2021-12-25 08:21:30 +08:00
| colorscheme | description |
| --------------- | ------------------------------------------------------------------------------------------ |
| `zenwritten` | Zero hue and saturation version |
| `neobones` | Inspired by [neovim.io](https://neovim.io) |
| `vimbones` | Inspired by [vim.org](https://www.vim.org) |
| `rosebones` | Inspired by [Rosé Pine](https://rosepinetheme.com) |
| `forestbones` | Inspired by [Everforest](https://github.com/sainnhe/everforest) |
| `nordbones` | Inspired by [Nord](https://www.nordtheme.com/docs/colors-and-palettes) |
| `tokyobones` | Inspired by [Tokyo Night](https://github.com/enkia/tokyo-night-vscode-theme#color-palette) |
| `seoulbones` | Inspired by [Seoul256](https://github.com/junegunn/seoul256.vim) |
| `duckbones` | Inspired by [Spaceduck](https://pineapplegiant.github.io/spaceduck) |
| `zenburned` | Inspired by [Zenburn](https://kippura.org/zenburnpage) |
| `kanagawabones` | Inspired by [Kanagawa](https://github.com/rebelot/kanagawa.nvim) |
| `randombones` | Randomly pick from the collection. |
document collection as table
2021-11-04 18:06:47 +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
doc: remove mention of zenflesh
2021-11-01 17:06:22 +08:00
| light | dark |
add more showcase
2021-09-18 16:46:09 +08:00
| :------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: |
| ![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
format readme
2021-12-04 10:14:15 +08:00
See more [showcase](doc/showcase.md) from the other colorschemes or checkout the
[vimcolorschemes page](https://vimcolorschemes.com/mcchrish/zenbones.nvim).
add link to flavor screenshots
2021-10-20 18:02:20 +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)
support cmp and organize fg selection
2021-10-23 18:07:52 +08:00
- [Cmp](https://github.com/hrsh7th/nvim-cmp)
update readme
2021-08-29 10:59:04 +08:00
- [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)
chore: add prettier config
2021-10-29 17:00:45 +08:00
- [n³](https://github.com/mcchrish/nnn.vim)
feat: support mason.nvim
2022-08-07 11:20:19 +08:00
- [Mason](https://github.com/williamboman/mason.nvim)
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)
chore: format
2021-12-28 07:05:45 +08:00
- [Windows Terminal](extras/windows_terminal)
feat(foot): Support foot terminal
2021-12-30 21:33:14 +01:00
- [Foot](extras/foot)
update links
2021-09-17 19:44:55 +08:00
- [Tmux](extras/tmux)
more readme
2021-08-25 14:33:40 +08:00
doc: cleanup
2021-11-07 08:37:59 +08:00
It's also possible to generate any color configuration files using shipwright,
[this one for Kitty](lua/zenbones/shipwright/runners/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).
Reference in New Issue Copy Permalink