Mercurial > ec-dotfiles

comparison vendor/vim-packs/srcery-vim/doc/srcery.txt @ 726:78469331407e default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update syntaxes
author nanaya <me@nanaya.net>
date Mon, 19 Aug 2024 17:04:13 +0900
parents 1e0f578f6752
children
comparison
equal deleted inserted replaced
725:0a896ffe3029 726:78469331407e
7 License: MIT license 7 License: MIT license
8 8
9 CONTENTS *srcery-contents* 9 CONTENTS *srcery-contents*
10 10
11 Introduction |srcery-introduction| 11 Introduction |srcery-introduction|
12 Installation |srcery-installation| 12 Installation |srcery-installation|
13 Vim 8 |srcery-install-vim8| 13 Vim 8 |srcery-install-vim8|
14 Dein |srcery-install-dein| 14 Dein |srcery-install-dein|
15 Pathogen |srcery-install-pathogen| 15 Pathogen |srcery-install-pathogen|
16 Plug |srcery-install-plug| 16 Plug |srcery-install-plug|
17 Color Table |srcery-color-table| 17 Color Table |srcery-color-table|
18 Options |srcery-options| 18 Options |srcery-options|
19 g:srcery_[color] |srcery-option-color| 19 g:srcery_[color] |srcery-option-color|
20 g:srcery_bold |srcery-option-bold| 20 g:srcery_bold |srcery-option-bold|
21 g:srcery_italic |srcery-option-italic| 21 g:srcery_italic |srcery-option-italic|
22 g:srcery_underline |srcery-option-underline| 22 g:srcery_underline |srcery-option-underline|
23 g:srcery_undercurl |srcery-option-undercurl| 23 g:srcery_undercurl |srcery-option-undercurl|
24 g:srcery_inverse |srcery-option-inverse| 24 g:srcery_strikethrough |srcery-option-strikethrough|
25 g:srcery_inverse_matche |srcery-option-inverse-matches| 25 g:srcery_inverse |srcery-option-inverse|
26 g:srcery_inverse_match_paren |srcery-option-inverse-match-paren| 26 g:srcery_inverse_matche |srcery-option-inverse-matches|
27 g:srcery_dim_lisp_paren |srcery-option-dim-lisp-paren| 27 g:srcery_inverse_match_paren |srcery-option-inverse-match-paren|
28 g:srcery_bg_passthrough |srcery-option-bg-passthrough| 28 g:srcery_dim_lisp_paren |srcery-option-dim-lisp-paren|
29 g:srcery_guisp_fallback |srcery-option-guisp-fallback| 29 g:srcery_guisp_fallback |srcery-option-guisp-fallback|
30 g:srcery_italic_types |srcery-option-italic-types| 30 g:srcery_italic_types |srcery-option-italic-types|
31 g:srcery_hard_black_terminal_bg |srcery-option-hard-black-terminal-bg| 31 g:srcery_bg |srcery-option-bg|
32 32 g:srcery_hard_black_terminal_bg |srcery-option-hard-black-terminal-bg|
33 ============================================================================== 33
34 INTRODUCTION *srcery-introduction* 34 ==============================================================================
35 INTRODUCTION *srcery-introduction*
35 36
36 Created using colors that logically adheres to the 16 color base palette of a 37 Created using colors that logically adheres to the 16 color base palette of a
37 given terminal, while trying to retain its own identity. The colors are 38 given terminal, while trying to retain its own identity. The colors are
38 designed to be easy on the eyes yet contrast well with the background for long 39 designed to be easy on the eyes yet contrast well with the background for long
39 sessions using an editor or terminal emulator. 40 sessions using an editor or terminal emulator.
40 41
41 ============================================================================== 42 ==============================================================================
42 INSTALLATION *srcery-installation* 43 INSTALLATION *srcery-installation*
43 44
44 Put srcery.vim in `~/.vim/colors/` (on unix-like systems) or 45 Download or clone srcery's repository to a location of your choosing and set
45 `%userprofile%\vimfiles\colors\` (on Windows). 46 your 'runtimepath' correctly, otherwise srcery will not work as it relies on
47 'autoload' functionality.
48
49 You can also install with your favourite plugin manager.
46 50
47 *srcery-install-vim8* 51 *srcery-install-vim8*
48 52
49 Vim 8 has native support for loading plugins. All you need to do to is to 53 Vim 8 has native support for loading plugins by using |packages|. All you need
50 clone this repository into `~/.vim/plug/default/opt`. 54 to do to, is to clone this repository into `~/.vim/pack/themes/opt`.
51 > 55 >
52 git clone https://github.com/srcery-colors/srcery-vim \ 56 git clone https://github.com/srcery-colors/srcery-vim \
53 ~/.vim/plug/default/opt 57 ~/.vim/pack/themes/opt
58 <
59 And then set your `.vimrc` accordingly.
60 >
61 packadd! srcery-vim
62 colorscheme srcery
54 < 63 <
55 64
56 The same works for Neovim, but you have to clone it into a path where Neovim 65 The same works for Neovim, but you have to clone it into a path where Neovim
57 can find it. 66 can find it.
58 > 67 >
59 git clone https://github.com/srcery-colors/srcery-vim \ 68 git clone https://github.com/srcery-colors/srcery-vim \
60 ~/.config/nvim/plug/default/opt 69 $XDG_CONFIG_HOME/nvim/pack/themes/opt
61 < 70 <
62 71
63 *srcery-install-dein* 72 *srcery-install-dein*
64 https://github.com/Shougo/dein.vim 73 https://github.com/Shougo/dein.vim
65 > 74 >
78 < 87 <
79 88
80 ============================================================================== 89 ==============================================================================
81 COLOR TABLE *srcery-color-table* 90 COLOR TABLE *srcery-color-table*
82 91
83 | termcol | nr | var | hex | rgb | 92 | TERMCOL | NR | VAR | HEX | RGB |
84 | ------------- | -- | ------------------------- | ------- | ------------- | 93 | ------------- | -- | ----------------------- | ------- | ------------- |
85 | black | 0 | g:srcery_black | #1c1b19 | 28, 27, 25 | 94 | black | 0 | g:srcery_black | #1C1B19 | 28, 27, 25 |
86 | red | 1 | g:srcery_red | #ef2f27 | 239, 47, 39 | 95 | red | 1 | g:srcery_red | #EF2F27 | 239, 47, 39 |
87 | green | 2 | g:srcery_green | #519f50 | 81, 159, 80 | 96 | green | 2 | g:srcery_green | #519F50 | 81, 159, 80 |
88 | yellow | 3 | g:srcery_yellow | #fbb829 | 251, 184, 41 | 97 | yellow | 3 | g:srcery_yellow | #FBB829 | 251, 184, 41 |
89 | blue | 4 | g:srcery_blue | #2c78bf | 44, 120, 191 | 98 | blue | 4 | g:srcery_blue | #2C78BF | 44, 120, 191 |
90 | magenta | 5 | g:srcery_magenta | #e02c6d | 224, 44, 109 | 99 | magenta | 5 | g:srcery_magenta | #E02C6D | 224, 44, 109 |
91 | cyan | 6 | g:srcery_cyan | #0aaeb3 | 10, 174, 179 | 100 | cyan | 6 | g:srcery_cyan | #0AAEB3 | 10, 174, 179 |
92 | white | 7 | g:srcery_white | #baa67f | 186, 166, 127 | 101 | white | 7 | g:srcery_white | #BAA67F | 186, 166, 127 |
93 | brightblack | 8 | g:srcery_bright_black | #918175 | 145, 129, 117 | 102 | brightblack | 8 | g:srcery_bright_black | #918175 | 145, 129, 117 |
94 | brightred | 9 | g:srcery_bright_red | #f75341 | 247, 83, 65 | 103 | brightred | 9 | g:srcery_bright_red | #F75341 | 247, 83, 65 |
95 | brightgreen | 10 | g:srcery_bright_green | #98bc37 | 152, 188, 55 | 104 | brightgreen | 10 | g:srcery_bright_green | #98BC37 | 152, 188, 55 |
96 | brightyellow | 11 | g:srcery_bright_yellow | #fed06e | 254, 208, 110 | 105 | brightyellow | 11 | g:srcery_bright_yellow | #FED06E | 254, 208, 110 |
97 | brightblue | 12 | g:srcery_bright_blue | #68a8e4 | 104, 168, 228 | 106 | brightblue | 12 | g:srcery_bright_blue | #68A8E4 | 104, 168, 228 |
98 | brightmagenta | 13 | g:srcery_bright_magenta | #ff5c8f | 255, 92, 143 | 107 | brightmagenta | 13 | g:srcery_bright_magenta | #FF5C8F | 255, 92, 143 |
99 | brightcyan | 14 | g:srcery_bright_cyan | #2be4d0 | 43, 228, 208 | 108 | brightcyan | 14 | g:srcery_bright_cyan | #2BE4D0 | 43, 228, 208 |
100 | brightwhite | 15 | g:srcery_bright_white | #fce8c3 | 252, 232, 195 | 109 | brightwhite | 15 | g:srcery_bright_white | #FCE8C3 | 252, 232, 195 |
101 110
102 Additionally Srcery uses some xterm 256 colors to pad out the color selection, 111 Additionally Srcery uses some xterm 256 colors to pad out the color selection,
103 no extra configuration needed. 112 no extra configuration needed.
104 113
105 | NAME | NR | VAR | HEX | RGB | 114 | NAME | NR | VAR | HEX | RGB |
117 ============================================================================== 126 ==============================================================================
118 OPTIONS *srcery-options* 127 OPTIONS *srcery-options*
119 128
120 Srcery includes a few toggles due to discrepancies in the various setups 129 Srcery includes a few toggles due to discrepancies in the various setups
121 possible. To change any of these you’d put something like this in your .vimrc: 130 possible. To change any of these you’d put something like this in your .vimrc:
122
123 > 131 >
124 let g:srcery_italic = 1 132 let g:srcery_italic = 1
125 < 133 <
126
127 Make sure that you set these variables before assigning colorscheme. 134 Make sure that you set these variables before assigning colorscheme.
128 135
129 g:srcery_[color] *srcery-option-color* 136 g:srcery_[color] *srcery-option-color*
130 137
131 You can customize each of Srcery’s colors, to customize say the red color: 138 You can customize each of Srcery’s colors, to customize say the red color:
132 > 139 >
133 let g:srcery_red = '#FF0000' 140 let g:srcery_red = '#FF0000'
141 <
142 Inside a 256-color terminal emulator, additional colors are configurable
143 via setting the corresponding variable with the _cterm suffix, e.g.
144 >
145 let g:srcery_hard_black_cterm = 232
134 < 146 <
135 Refer to the |srcery-color-table| for a full list of color variables, hexes 147 Refer to the |srcery-color-table| for a full list of color variables, hexes
136 and more. 148 and more.
137 149
138 *srcery-option-bold* 150 *srcery-option-bold*
158 170
159 *srcery-option-undercurl* 171 *srcery-option-undercurl*
160 g:srcery_undercurl 172 g:srcery_undercurl
161 173
162 Enables undercurled text. 174 Enables undercurled text.
175
176 Default: 1
177
178 *srcery-option-strikethrough*
179 g:srcery_strikethrough
180
181 Enables strikethrough text.
163 182
164 Default: 1 183 Default: 1
165 184
166 *srcery-option-inverse* 185 *srcery-option-inverse*
167 g:srcery_inverse 186 g:srcery_inverse
190 209
191 Works best with Rainbow parenthesis. 210 Works best with Rainbow parenthesis.
192 211
193 Default: 0 212 Default: 0
194 213
195 *srcery-option-dim-lisp-paren* 214 *srcery-option-dim-lisp-paren*
196 g:srcery_dim_lisp_paren 215 g:srcery_dim_lisp_paren
197 216
198 Dims lisp dialects delimiters to a fairly dark gray (xgray5 217 Dims lisp dialects delimiters to a fairly dark gray (xgray5
199 specifically). 218 specifically).
200
201 Default: 0
202
203 *srcery-option-bg-passthrough*
204 g:srcery_bg_passthrough
205
206 Lets the terminal control the background color in Vim by setting the
207 background NONE.
208
209 A possible use case for this could be you want to manipulate the
210 background color in the terminal, and let the results bubble up to
211 Vim.
212 219
213 Default: 0 220 Default: 0
214 221
215 *srcery-option-guisp-fallback* 222 *srcery-option-guisp-fallback*
216 g:srcery_guisp_fallback 223 g:srcery_guisp_fallback
232 239
233 Italicize types if italic is enabled. 240 Italicize types if italic is enabled.
234 241
235 Default: 0 242 Default: 0
236 243
244 *srcery-option-bg*
245 g:srcery_bg
246
247 Let's you customize the background color. This var takes a list with
248 two values, with a quoted HEX in the first position, and a terminal
249 color index for the second position. This lets you set both a 24-bit
250 color, and a 8bit terminal color index.
251
252 You can specify `'NONE'` as one of the values to make it transparent,
253 as such `['NONE', 'NONE']` would be the same as the previous option
254 `g:srcery_bg_passthrough = 1`.
255
256
257 You can specify `'DEFAULT'` as one of the values in order to use that
258 position's default value.
259
260 Default: `[g:srcery_black, 0]`
261
237 *srcery-option-hard-black-terminal-bg* 262 *srcery-option-hard-black-terminal-bg*
238 g:srcery_hard_black_terminal_bg 263 g:srcery_hard_black_terminal_bg
239 264
240 If enabled, will set the terminal background in vim to hard black. 265 If enabled, will set the terminal background in vim to hard black.
241 Note that this currently only works in Vim, not Neovim. 266 Note that this currently only works in Vim, not Neovim.
242 267
243 Default: 1 268 Default: 1
244 269