Skip to content

Commit 6aea9c6

Browse files
github-actions[bot]github-actions[bot]
authored
chore: generated vimdoc (#115)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 9ef93d6 commit 6aea9c6

File tree

1 file changed

+79
-55
lines changed

1 file changed

+79
-55
lines changed

‎doc/zenbones.txt

+79-55
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,29 @@
44
Table of Contents *zenbones-table-of-contents*
55

66
1. Documentation |zenbones-documentation|
7-
- Requirement |zenbones-requirement|
8-
- Usage |zenbones-usage|
9-
- Configuration |zenbones-configuration|
10-
- Advanced Usage |zenbones-advanced-usage|
7+
- Requirement |zenbones-documentation-requirement|
8+
- Usage |zenbones-documentation-usage|
9+
- Configuration |zenbones-documentation-configuration|
10+
- Advanced Usage |zenbones-documentation-advanced-usage|
1111

1212
==============================================================================
1313
1. Documentation *zenbones-documentation*
1414

1515
A collection of Vim/Neovim colorschemes designed to highlight code using
1616
contrasts and font variations.
1717

18-
REQUIREMENT *zenbones-requirement*
18+
19+
REQUIREMENT *zenbones-documentation-requirement*
1920

2021

2122
- Neovim v0.8.0 (use v2.0.0 for older versions) or Vim 8.1
2223

2324

24-
USAGE *zenbones-usage*
25+
USAGE *zenbones-documentation-usage*
2526

2627
Just apply the colorscheme as usual:
2728

28-
>
29+
>vim
2930
set termguicolors
3031
set background=light " or dark
3132

@@ -47,95 +48,120 @@ Just apply the colorscheme as usual:
4748
<
4849

4950

50-
CONFIGURATION *zenbones-configuration*
51+
CONFIGURATION *zenbones-documentation-configuration*
5152

5253
Configuration is only available for Neovim. There are two ways to set
5354
configuration. First:
5455

55-
>
56+
>vim
5657
" vimscript
5758
let g:zenbones_solid_line_nr = v:true
5859
let g:zenbones_darken_comments = 45
5960
<
6061

61-
62-
>
62+
>lua
6363
-- lua
6464
vim.g.zenbones_solid_line_nr = true
6565
vim.g.zenbones_darken_comments = 45
6666
<
6767

68-
6968
Second way is to set configuration is to assign a dictionary to the prefix:
7069

71-
>
70+
>vim
7271
" vimscript
7372
let g:forestbones = #{ solid_line_nr: v:true, darken_comments: 45 }
7473
<
7574

76-
77-
>
75+
>lua
7876
-- lua
7977
vim.g.forestbones = { solid_line_nr = true, darken_comments = 45 }
8078
<
8179

82-
8380
**Notes**: Flavors accept their own configuration by replacing the prefix with
8481
the flavor name e.g. `g:rosebones_italic_comments`.
8582

86-
│ Option │Background│ Default │ Description │
87-
│lightness │light │nil │Change background colors lightness. Options: 'bright', 'dim'. │
88-
│darkness │dark │nil │Change background colors darkness. Options: 'stark', 'warm'. │
89-
│solid_vert_split │both │false │Solid |hl-VertSplit| background. │
90-
│solid_line_nr │both │false │Solid |hl-LineNr| background. │
91-
│solid_float_border │both │false │Make |hl-FloatBorder| have a more distinguishable background highlight.│
92-
│darken_noncurrent_window │light │false │Make non-current window background darker than _Normal_. │
93-
│lighten_noncurrent_window │dark │false │Make non-current window background lighter than _Normal_. │
94-
│italic_comments │both │true │Make comments italicize. │
95-
│darken_comments │light │38 │Percentage to darken comments relative to Normal bg. │
96-
│lighten_comments │dark │38 │Percentage to lighten comments relative to Normal bg. │
97-
│darken_non_text │light │25 │Percentage to darken |hl-NonText| relative to Normal bg. │
98-
│lighten_non_text │dark │30 │Percentage to lighten |hl-NonText| relative to Normal bg. │
99-
│darken_line_nr │light │33 │Percentage to darken |hl-LineNr| relative to Normal bg. │
100-
│lighten_line_nr │dark │35 │Percentage to lighten |hl-LineNr| relative to Normal bg. │
101-
│darken_cursor_line │light │3 │Percentage to darken |hl-CursorLine| relative to Normal bg. │
102-
│lighten_cursor_line │dark │4 │Percentage to lighten |hl-CursorLine| relative to Normal bg. │
103-
│colorize_diagnostic_underline_text│both │false │Colorize the fg of DiagnosticUnderline*. │
104-
│transparent_background │both │false │Make background transparent. │
105-
106-
107-
*zenbones-g:bones_compat*
108-
109-
g:bones_compat Set to `1` to enable compatibility mode
110-
for all colorschemes. Enabled in Vim. To
111-
enable/disable compatibility mode for a
112-
specific theme, set the variable
113-
`g:{theme}_compat` to `0` or `1`,
114-
e.g. `let g:zenbones_compat = 1`.
83+
-----------------------------------------------------------------------------------------------------
84+
Option Background Default Description
85+
------------------------------------ ------------ --------- -----------------------------------------
86+
lightness light nil Change background colors lightness.
87+
Options: 'bright', 'dim'.
88+
89+
darkness dark nil Change background colors darkness.
90+
Options: 'stark', 'warm'.
91+
92+
solid_vert_split both false Solid |hl-VertSplit| background.
93+
94+
solid_line_nr both false Solid |hl-LineNr| background.
95+
96+
solid_float_border both false Make |hl-FloatBorder| have a more
97+
distinguishable background highlight.
98+
99+
darken_noncurrent_window light false Make non-current window background darker
100+
than Normal.
101+
102+
lighten_noncurrent_window dark false Make non-current window background
103+
lighter than Normal.
104+
105+
italic_comments both true Make comments italicize.
106+
107+
darken_comments light 38 Percentage to darken comments relative to
108+
Normal bg.
109+
110+
lighten_comments dark 38 Percentage to lighten comments relative
111+
to Normal bg.
112+
113+
darken_non_text light 25 Percentage to darken |hl-NonText|
114+
relative to Normal bg.
115+
116+
lighten_non_text dark 30 Percentage to lighten |hl-NonText|
117+
relative to Normal bg.
118+
119+
darken_line_nr light 33 Percentage to darken |hl-LineNr| relative
120+
to Normal bg.
121+
122+
lighten_line_nr dark 35 Percentage to lighten |hl-LineNr|
123+
relative to Normal bg.
124+
125+
darken_cursor_line light 3 Percentage to darken |hl-CursorLine|
126+
relative to Normal bg.
127+
128+
lighten_cursor_line dark 4 Percentage to lighten |hl-CursorLine|
129+
relative to Normal bg.
130+
131+
colorize_diagnostic_underline_text both false Colorize the fg of DiagnosticUnderline*.
132+
133+
transparent_background both false Make background transparent.
134+
-----------------------------------------------------------------------------------------------------
135+
136+
G:BONES_COMPAT
137+
138+
Set to `1` to enable compatibility mode for all colorschemes. Enabled in Vim.
139+
To enable/disable compatibility mode for a specific theme, set the variable
140+
`g:{theme}_compat` to `0` or `1`, e.g. `let g:zenbones_compat = 1`.
115141

116142

117143
LIGHTLINE ~
118144

119-
>
145+
>vim
120146
let g:lightline = #{ colorscheme: 'zenbones' } " or any other flavor
121147
<
122148

123149

124150
LUALINE ~
125151

126-
>
152+
>lua
127153
require("lualine").setup {
128154
options = { theme = "zenbones" }, -- or any other flavor
129155
}
130156
<
131157

132158

133-
ADVANCED USAGE *zenbones-advanced-usage*
159+
ADVANCED USAGE *zenbones-documentation-advanced-usage*
134160

135161
Zenbones is pretty extensible thanks to Lush. You can easily retrieve the
136162
colors in lua:
137163

138-
>
164+
>lua
139165
local theme = require "zenbones" -- or any other flavor
140166
local palette = require "zenbones.palette"
141167

@@ -150,7 +176,7 @@ Here’s an example of how to extend/override some highlights.
150176

151177
`lua/customize_zenbones.lua`:
152178

153-
>
179+
>lua
154180
local lush = require "lush"
155181
local base = require "zenbones"
156182

@@ -164,18 +190,17 @@ Here’s an example of how to extend/override some highlights.
164190
lush.apply(lush.compile(specs))
165191
<
166192

167-
168193
And then somewhere in your `init.vim`:
169194

170-
>
195+
>vim
171196
autocmd ColorScheme zenbones lua require "customize_zenbones"
172197
colorscheme zenbones
173198
<
174199

175-
176200
See also Lush’s documentation
177201
<https://github.com/rktjmp/lush.nvim#advanced-usage> for more options.
178202

203+
179204
CREATE YOUR OWN COLORSCHEME ~
180205

181206
You can ultimately create your own colorscheme that is based on zenbones by
@@ -186,7 +211,7 @@ through an example. Let’s make a zenbones-flavored Gruvbox colorscheme called
186211
Let’s define our |colorscheme| in `colors/gruvbones.lua`. It contains the
187212
following:
188213

189-
>
214+
>lua
190215
local colors_name = "gruvbones"
191216
vim.g.colors_name = colors_name -- Required when defining a colorscheme
192217

@@ -243,7 +268,6 @@ following:
243268
require("zenbones.term").apply_colors(palette)
244269
<
245270

246-
247271
And there you have it. Just call `colorscheme gruvbones` to use your new
248272
colorscheme. It respects `&background` and other configurations too.
249273

0 commit comments

Comments
 (0)