diff --git a/doc/zenbones.txt b/doc/zenbones.txt index 4938d9d..db93f6f 100644 --- a/doc/zenbones.txt +++ b/doc/zenbones.txt @@ -3,48 +3,15 @@ ============================================================================== Table of Contents *zenbones-table-of-contents* -1. Zenflesh, Zenbones |zenbones-zenflesh,-zenbones| - - Requirements |zenbones-requirements| - - Installation |zenbones-installation| - Usage |zenbones-usage| - Configuration |zenbones-configuration| - Advanced Usage |zenbones-advanced-usage| - - Other plugins support |zenbones-other-plugins-support| - - Other implementations |zenbones-other-implementations| - - Inspirations |zenbones-inspirations| - -============================================================================== -1. Zenflesh, Zenbones *zenbones-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. - -REQUIREMENTS *zenbones-requirements* - -Primarily built for neovim but it works pretty well with vim. However here are -some requirements to take full advantage of the colorscheme: - - -- 24-bit RGB colors (neovim or vim compiled with +termguicolors) i.e. - `set 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 -< +diagnostics, +diffs, search matches. USAGE *zenbones-usage* @@ -75,47 +42,33 @@ Configuration is only available for `zenbones-lush` and `zenflesh-lush`. *zenbones-g:zenbones_lightness* g:zenbones_lightness Change background colors lightness. - - -│ 'bright' │ _(unset)_ │ 'dim' │ -│ │ 6ccf7d.png' title=''/> │ be1cb8.png' title=''/> │ + Options: `'bright'`, `'dim'`. *zenbones-g:zenflesh_darkness* g:zenflesh_darkness Change background colors darkness. - - -│ 'stark' │ _(unset)_ │ 'warm' │ -│ │ 7a95fc.png' title=''/> │ 113b91.png' title=''/> │ + Options: `'stark'`, `'warm'`. *zenbones-g:zenbones_solid_vert_split* *zenbones-g:zenflesh_solid_vert_split* -g:zenflesh_solid_vert_split Set to `v:true` to make vertical split +g:zenflesh_solid_vert_split Default: `v:false` Make vertical split more distinguishable background highlight. *zenbones-g:zenbones_dim_noncurrent_window* -g:zenbones_dim_noncurrent_window Set to `v:true` to make non-current +g:zenbones_dim_noncurrent_window Default: `v:false` Make non-current window background dimmer than _Normal_. *zenbones-g:zenflesh_lighten_noncurrent_window* -g:zenflesh_lighten_noncurrent_window Set to `v:true` to make non-current +g:zenflesh_lighten_noncurrent_window Default: `v:false` Make non-current window background warmer than _Normal_. @@ -123,7 +76,7 @@ g:zenflesh_lighten_noncurrent_window Set to `v:true` to make non-current *zenbones-g:zenflesh_italic_comments* -g:zenflesh_italic_comments Set to `v:false` to make comments not +g:zenflesh_italic_comments Default: `v:true` Make comments not italicize. @@ -144,52 +97,6 @@ colors in lua: See also Lush’s documentation for more options. -OTHER PLUGINS SUPPORT *zenbones-other-plugins-support* - -Aside from LSP and basic Tree-sitter support, here are some plugins that are -currently supported. - - -- Git Signs -- Git Gutter -- Indent Blankline -- Telescope -- Sneak -- Lightspeed -- Hop -- Lualine -- Lightline -- BarBar -- CoC -- Neogit -- WhichKey -- Trouble - - -OTHER IMPLEMENTATIONS *zenbones-other-implementations* - - -- iTerm2 -- Kitty -- Alacritty -- WezTerm -- Tmux - - -It’s also possible to generate color configuration files using a template, -this one for Kitty for example. Please feel free -to submit a PR if you want to add some more. - -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 -. - Generated by panvimdoc vim:tw=78:ts=8:noet:ft=help:norl: