finn/zenbones-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

separate docs file and auto-generation

Browse Source
This commit is contained in:
Michael Chris Lopez
2021-09-18 16:07:20 +08:00
parent 7963db098e
commit 452745cd81
3 changed files with 78 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/doc.yml vendored
View File

@@ -28,6 +28,7 @@ jobs:
with:
# Output vimdoc project name
vimdoc: zenbones
pandoc: doc/zenbones.md
description: "A contrast-focused vim/neovim colorscheme"
version: "Vim v8.1 / Neovim 0.5.0"
- uses: stefanzweifel/git-auto-commit-action@v4

57
README.md
View File

@@ -4,16 +4,12 @@ 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.
<!-- panvimdoc-ignore-start -->
![Zenbones main image](https://user-images.githubusercontent.com/7200153/133774819-32b4e18b-6af7-48ac-91d5-16c4f413ad20.jpg)
<p align="center">
<em>A rock garden in <a href="https://en.wikipedia.org/wiki/Ry%C5%8Dan-ji">Ryōan-ji</a>.</em>
</p>
<!-- panvimdoc-ignore-end -->
## Requirements
Primarily built for neovim but it works pretty well with vim. However here are
@@ -54,67 +50,20 @@ 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 and other documentations
## Configuration
See [doc](doc/zenbones.md).
Configuration is only available for `zenbones-lush` and `zenflesh-lush`.
#### g:zenbones_lightness
Change background colors lightness.
## Showcase
| 'bright' | _(unset)_ | 'dim' |
| :-----------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
| ![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) |
#### g:zenflesh_darkness
Change background colors darkness.
| 'stark' | _(unset)_ | 'warm' |
| :---------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------: |
| ![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) |
#### g:zenbones_solid_vert_split
#### g:zenflesh_solid_vert_split
Set to `v:true` to make vertical split more distinguishable background
highlight.
#### g:zenbones_dim_noncurrent_window
Set to `v:true` to make non-current window background dimmer than _Normal_.
#### g:zenflesh_lighten_noncurrent_window
Set to `v:true` to make non-current window background warmer than _Normal_.
#### g:zenbones_italic_comments
#### g:zenflesh_italic_comments
Set to `v:false` to make comments not italicize.
## Advanced Usage
Zenbones is pretty extensible thanks to Lush. You can easily retrieve the colors
in lua:
```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
[Lush's documentation](https://github.com/rktjmp/lush.nvim#advanced-usage) for
more options.
## Other plugins support
Aside from LSP and basic Tree-sitter support, here are some plugins that are

74
doc/zenbones.md Normal file
View File

@@ -0,0 +1,74 @@
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
Just apply the colorscheme as usual:
```vim
colorscheme zenbones " light
colorscheme zenflesh " dark
```
If you want to make use of the lua version:
```vim
" 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
Configuration is only available for `zenbones-lush` and `zenflesh-lush`.
#### g:zenbones_lightness
Change background colors lightness. Options: `'bright'`, `'dim'`.
#### g:zenflesh_darkness
Change background colors darkness. Options: `'stark'`, `'warm'`.
#### g:zenbones_solid_vert_split
#### g:zenflesh_solid_vert_split
Default: `v:false` Make vertical split more distinguishable background
highlight.
#### g:zenbones_dim_noncurrent_window
Default: `v:false` Make non-current window background dimmer than _Normal_.
#### g:zenflesh_lighten_noncurrent_window
Default: `v:false` Make non-current window background warmer than _Normal_.
#### g:zenbones_italic_comments
#### g:zenflesh_italic_comments
Default: `v:true` Make comments not italicize.
## Advanced Usage
Zenbones is pretty extensible thanks to Lush. You can easily retrieve the colors
in lua:
```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
[Lush's documentation](https://github.com/rktjmp/lush.nvim#advanced-usage) for
more options.