Files
zenbones-theme/doc/zenbones.txt

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

105 lines
3.6 KiB
Plaintext
Raw Normal View History

2021-09-17 11:55:56 +00:00
*zenbones.txt* A contrast-focused vim/neovim colorscheme
2021-08-27 02:01:48 +00:00
==============================================================================
Table of Contents *zenbones-table-of-contents*
2021-09-18 08:12:24 +00:00
1. Zenbones |zenbones-zenbones|
2021-08-27 08:09:41 +00:00
- Usage |zenbones-usage|
2021-08-30 01:35:08 +00:00
- Configuration |zenbones-configuration|
2021-08-31 02:48:36 +00:00
- Advanced Usage |zenbones-advanced-usage|
2021-08-27 02:01:48 +00:00
2021-09-18 08:12:24 +00:00
==============================================================================
1. Zenbones *zenbones-zenbones*
2021-08-27 02:01:48 +00:00
2021-09-18 08:12:24 +00:00
**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.
2021-08-27 02:01:48 +00:00
2021-08-27 08:35:18 +00:00
USAGE *zenbones-usage*
2021-08-27 02:01:48 +00:00
Just apply the colorscheme as usual:
>
2021-09-17 11:55:56 +00:00
colorscheme zenbones " light
colorscheme zenflesh " dark
2021-08-27 02:01:48 +00:00
<
2021-09-05 01:23:38 +00:00
If you want to make use of the lua version:
2021-08-27 02:01:48 +00:00
>
2021-09-12 06:41:36 +00:00
" Requires `neovim` and `rktjmp/lush.nvim` installed
2021-08-27 02:01:48 +00:00
colorscheme zenbones-lush
2021-09-17 11:55:56 +00:00
colorscheme zenflesh-lush
2021-08-27 02:01:48 +00:00
<
It works pretty much the same as the first one but pretty handy when extending
or customizing the colors to your likings.
2021-08-30 01:35:08 +00:00
CONFIGURATION *zenbones-configuration*
2021-09-17 11:55:56 +00:00
Configuration is only available for `zenbones-lush` and `zenflesh-lush`.
2021-08-31 02:48:36 +00:00
2021-08-30 01:35:08 +00:00
*zenbones-g:zenbones_lightness*
2021-09-01 05:21:19 +00:00
g:zenbones_lightness Change background colors lightness.
2021-09-18 08:08:27 +00:00
Options: `'bright'`, `'dim'`.
2021-08-30 01:35:08 +00:00
2021-09-17 11:55:56 +00:00
*zenbones-g:zenflesh_darkness*
2021-08-30 01:35:08 +00:00
2021-09-17 11:55:56 +00:00
g:zenflesh_darkness Change background colors darkness.
2021-09-18 08:08:27 +00:00
Options: `'stark'`, `'warm'`.
2021-09-17 11:55:56 +00:00
2021-08-30 01:35:08 +00:00
2021-08-31 02:48:36 +00:00
*zenbones-g:zenbones_solid_vert_split*
2021-09-17 11:55:56 +00:00
*zenbones-g:zenflesh_solid_vert_split*
2021-09-18 08:17:07 +00:00
g:zenflesh_solid_vert_split Default: `v:false`. Make vertical split
more distinguishable background
highlight.
2021-09-18 08:12:24 +00:00
2021-08-31 02:48:36 +00:00
*zenbones-g:zenbones_dim_noncurrent_window*
2021-09-18 08:17:07 +00:00
g:zenbones_dim_noncurrent_window Default: `v:false`. Make non-current
window background dimmer than _Normal_.
2021-09-05 01:23:38 +00:00
2021-09-17 11:55:56 +00:00
*zenbones-g:zenflesh_lighten_noncurrent_window*
2021-09-18 08:17:07 +00:00
g:zenflesh_lighten_noncurrent_window Default: `v:false`. Make non-current
window background warmer than _Normal_.
2021-09-17 11:55:56 +00:00
*zenbones-g:zenbones_italic_comments*
*zenbones-g:zenflesh_italic_comments*
2021-09-18 08:17:07 +00:00
g:zenflesh_italic_comments Default: `v:true`. Make comments not
italicize.
2021-09-17 11:55:56 +00:00
2021-09-05 00:19:48 +00:00
ADVANCED USAGE *zenbones-advanced-usage*
2021-09-12 06:41:36 +00:00
Zenbones is pretty extensible thanks to Lush. You can easily retrieve the
colors in lua:
2021-09-05 00:19:48 +00:00
>
2021-09-17 11:55:56 +00:00
local theme = require "zenbones" -- or zenflesh
2021-09-12 14:19:33 +08:00
local palette = require "zenbones.palette"
2021-09-05 00:19:48 +00:00
print(theme.StatusLine.bg.hex)
2021-09-17 11:55:56 +00:00
print(palette.blossom.darken(20).hex)
2021-09-05 00:19:48 +00:00
<
2021-08-31 02:48:36 +00:00
2021-09-05 01:23:38 +00:00
See also Lushs documentation
2021-09-12 06:41:36 +00:00
<https://github.com/rktjmp/lush.nvim#advanced-usage> for more options.
2021-08-31 02:48:36 +00:00
2021-08-27 21:02:03 +00:00
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
2021-08-27 02:01:48 +00:00
vim:tw=78:ts=8:noet:ft=help:norl: