Files
zenbones-theme/doc/zenbones.txt
2021-09-18 08:17:07 +00:00

105 lines
3.6 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
*zenbones.txt* A contrast-focused vim/neovim colorscheme
==============================================================================
Table of Contents *zenbones-table-of-contents*
1. Zenbones |zenbones-zenbones|
- Usage |zenbones-usage|
- Configuration |zenbones-configuration|
- Advanced Usage |zenbones-advanced-usage|
==============================================================================
1. Zenbones *zenbones-zenbones*
**Zenflesh, 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.
USAGE *zenbones-usage*
Just apply the colorscheme as usual:
>
colorscheme zenbones " light
colorscheme zenflesh " dark
<
If you want to make use of the lua version:
>
" Requires `neovim` and `rktjmp/lush.nvim` installed
colorscheme zenbones-lush
colorscheme zenflesh-lush
<
It works pretty much the same as the first one but pretty handy when extending
or customizing the colors to your likings.
CONFIGURATION *zenbones-configuration*
Configuration is only available for `zenbones-lush` and `zenflesh-lush`.
*zenbones-g:zenbones_lightness*
g:zenbones_lightness Change background colors lightness.
Options: `'bright'`, `'dim'`.
*zenbones-g:zenflesh_darkness*
g:zenflesh_darkness Change background colors darkness.
Options: `'stark'`, `'warm'`.
*zenbones-g:zenbones_solid_vert_split*
*zenbones-g:zenflesh_solid_vert_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 Default: `v:false`. Make non-current
window background dimmer than _Normal_.
*zenbones-g:zenflesh_lighten_noncurrent_window*
g:zenflesh_lighten_noncurrent_window Default: `v:false`. Make non-current
window background warmer than _Normal_.
*zenbones-g:zenbones_italic_comments*
*zenbones-g:zenflesh_italic_comments*
g:zenflesh_italic_comments Default: `v:true`. Make comments not
italicize.
ADVANCED USAGE *zenbones-advanced-usage*
Zenbones is pretty extensible thanks to Lush. You can easily retrieve the
colors in lua:
>
local theme = require "zenbones" -- or zenflesh
local palette = require "zenbones.palette"
print(theme.StatusLine.bg.hex)
print(palette.blossom.darken(20).hex)
<
See also Lushs documentation
<https://github.com/rktjmp/lush.nvim#advanced-usage> for more options.
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
vim:tw=78:ts=8:noet:ft=help:norl: