diff --git a/doc/zenbones.txt b/doc/zenbones.txt index e69de29..4476a38 100644 --- a/doc/zenbones.txt +++ b/doc/zenbones.txt @@ -0,0 +1,203 @@ +zenbones.txt For NVIM v0.4.3 Last change: 2021 August 27 + +============================================================================== +Table of Contents *zenbones-table-of-contents* + +1. Zenbones |zenbones-zenbones| + +============================================================================== +1. Zenbones *zenbones-zenbones* + +Zenbones is a light vim/nvim 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

+
+ +

+ +A rock garden in Ryōan-ji. + +

+ +REQUIREMENTS *zenbones-requirements* + +Primarily built for nvim but it works pretty well with vim. However here are +some requirements to take full advantage of the colorscheme: + + +- 24-bit RGB colors (nvim or vim compiled with +termguicolors) +- Font with bold and italic +- Terminal or GUI with bold and italic support + + +INSTALLATION *zenbones-installation* + +Example installation using packer: + +> + 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 *zenbones-usage* + +Just apply the colorscheme as usual: + +> + set termguicolors + colorscheme zenbones +< + + +Alternatively, if you want to make use of the lua version: + +> + 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. + +SHOWCASE *zenbones-showcase* + +
+ + + +Diff highlights + + + +Vim diff + +
+ +
+ + + +Search + + + +Search + +
+ +
+ + + +Diagnostics + + + +Diagnostics + +
+ +_Font used is |Iosevka Curly Slab|_. + +OTHER PLUGINS SUPPORT *zenbones-other-plugins-support* + +Aside from LSP and basic Tree-sitter support, there are only a few plugins that +are currently supported. Please feel free to open a PR to support your favorite +plugins. + + +- |gitsigns| +- |indent-blankline| +- |Telescope| +- |sneak| +- |lualine| (requires Lush) +- |barbar.nvim| + + +ADVANCE USAGE *zenbones-advance-usage* + +Zenbones is pretty extensible thanks to |Lush|. You can easily retrieve the +colors in lua: + +> + local theme = require "zenbones" + local colors = require "zenbones.colors" + + print(theme.StatusLine.bg.hex) + print(sand.darken(20).hex) +< + + +One such example is the custom |lualine| theme. + +See also |Lush’s documentation| for the complete options. + +OTHER IMPLEMENTATIONS *zenbones-other-implementations* + + +- |iterm2| + + + *zenbones-Print terminal colors* + +Print terminal colors You can retrieve the terminal colors by + using this command: + + +> + :lua require("zenbones.print").print_terminal_colors() + + ... + Terminal colors + foreground: #2C363C + background: #F0EDEC + ansi color0: #2C363C + ansi color1: #C23C55 + ansi color2: #617437 + ansi color3: #914B27 + ansi color4: #286486 + ansi color5: #88507D + ... +< + + +Useful when you want to apply a zenbones theme to your terminal. + +INSPIRATIONS *zenbones-inspirations* + +Zenbones is heavily inspired by |Verdandi| and |vim-yin-yang|. The name came +from a book called |Zen Flesh, Zen Bones|. + +There are more similar |colorschemes with few colors from this collection|. +============================================================================== +Links *zenbones-links* + +- *sneak* https://github.com/justinmk/vim-sneak +- *colorschemes with few colors from this collection* https://github.com/mcchrish/vim-no-color-collections +- *Iosevka Curly Slab* https://typeof.net/Iosevka/ +- *Verdandi* https://github.com/be5invis/vsc-theme-verdandi +- *Lush* https://github.com/rktjmp/lush.nvim +- *Zen Flesh, Zen Bones* https://en.wikipedia.org/wiki/Zen_Flesh,_Zen_Bones +- *vim-yin-yang* https://github.com/pgdouyon/vim-yin-yang +- *indent-blankline* https://github.com/lukas-reineke/indent-blankline.nvim +- *lualine* lua/lualine/themes/zenbones.lua +- *iterm2* https://github.com/mcchrish/zenbones-iterm +- *Lush’s documentation* https://github.com/rktjmp/lush.nvim#advanced-usage +- *barbar.nvim* https://github.com/romgrk/barbar.nvim +- *Telescope* https://github.com/nvim-telescope/telescope.nvim +- *gitsigns* https://github.com/lewis6991/gitsigns.nvim + +vim:tw=78:ts=8:noet:ft=help:norl: