Mercurial > ec-dotfiles

comparison vendor/vim-packs/srcery-vim/doc/srcery.txt @ 704:1e0f578f6752

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update vendor and add support for vim packs
author nanaya <me@nanaya.net>
date Sun, 18 Dec 2022 20:06:46 +0900
parents
children 78469331407e
comparison
equal deleted inserted replaced
703:b7cd7465cc26 704:1e0f578f6752
1 *srcery.txt* Color scheme with clearly defined contrasting colors *srcery*
2 and a slightly earthy tone.
3
4 Version: 1.0.0
5 Author: Daniel Berg <mail@roosta.sh>
6 w/ contributers
7 License: MIT license
8
9 CONTENTS *srcery-contents*
10
11 Introduction |srcery-introduction|
12 Installation |srcery-installation|
13 Vim 8 |srcery-install-vim8|
14 Dein |srcery-install-dein|
15 Pathogen |srcery-install-pathogen|
16 Plug |srcery-install-plug|
17 Color Table |srcery-color-table|
18 Options |srcery-options|
19 g:srcery_[color] |srcery-option-color|
20 g:srcery_bold |srcery-option-bold|
21 g:srcery_italic |srcery-option-italic|
22 g:srcery_underline |srcery-option-underline|
23 g:srcery_undercurl |srcery-option-undercurl|
24 g:srcery_inverse |srcery-option-inverse|
25 g:srcery_inverse_matche |srcery-option-inverse-matches|
26 g:srcery_inverse_match_paren |srcery-option-inverse-match-paren|
27 g:srcery_dim_lisp_paren |srcery-option-dim-lisp-paren|
28 g:srcery_bg_passthrough |srcery-option-bg-passthrough|
29 g:srcery_guisp_fallback |srcery-option-guisp-fallback|
30 g:srcery_italic_types |srcery-option-italic-types|
31 g:srcery_hard_black_terminal_bg |srcery-option-hard-black-terminal-bg|
32
33 ==============================================================================
34 INTRODUCTION *srcery-introduction*
35
36 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 designed to be easy on the eyes yet contrast well with the background for long
39 sessions using an editor or terminal emulator.
40
41 ==============================================================================
42 INSTALLATION *srcery-installation*
43
44 Put srcery.vim in `~/.vim/colors/` (on unix-like systems) or
45 `%userprofile%\vimfiles\colors\` (on Windows).
46
47 *srcery-install-vim8*
48
49 Vim 8 has native support for loading plugins. All you need to do to is to
50 clone this repository into `~/.vim/plug/default/opt`.
51 >
52 git clone https://github.com/srcery-colors/srcery-vim \
53 ~/.vim/plug/default/opt
54 <
55
56 The same works for Neovim, but you have to clone it into a path where Neovim
57 can find it.
58 >
59 git clone https://github.com/srcery-colors/srcery-vim \
60 ~/.config/nvim/plug/default/opt
61 <
62
63 *srcery-install-dein*
64 https://github.com/Shougo/dein.vim
65 >
66 call dein#add('srcery-colors/srcery-vim')
67 <
68 *srcery-install-pathogen*
69 https://github.com/tpope/vim-pathogen
70 >
71 cd ~/.vim/bundle
72 git clone https://github.com/srcery-colors/srcery-vim
73 <
74 *srcery-install-plug*
75 https://github.com/junegunn/vim-plug
76 >
77 Plug 'srcery-colors/srcery-vim'
78 <
79
80 ==============================================================================
81 COLOR TABLE *srcery-color-table*
82
83 | termcol | nr | var | hex | rgb |
84 | ------------- | -- | ------------------------- | ------- | ------------- |
85 | black | 0 | g:srcery_black | #1c1b19 | 28, 27, 25 |
86 | red | 1 | g:srcery_red | #ef2f27 | 239, 47, 39 |
87 | green | 2 | g:srcery_green | #519f50 | 81, 159, 80 |
88 | yellow | 3 | g:srcery_yellow | #fbb829 | 251, 184, 41 |
89 | blue | 4 | g:srcery_blue | #2c78bf | 44, 120, 191 |
90 | magenta | 5 | g:srcery_magenta | #e02c6d | 224, 44, 109 |
91 | cyan | 6 | g:srcery_cyan | #0aaeb3 | 10, 174, 179 |
92 | white | 7 | g:srcery_white | #baa67f | 186, 166, 127 |
93 | brightblack | 8 | g:srcery_bright_black | #918175 | 145, 129, 117 |
94 | brightred | 9 | g:srcery_bright_red | #f75341 | 247, 83, 65 |
95 | brightgreen | 10 | g:srcery_bright_green | #98bc37 | 152, 188, 55 |
96 | brightyellow | 11 | g:srcery_bright_yellow | #fed06e | 254, 208, 110 |
97 | brightblue | 12 | g:srcery_bright_blue | #68a8e4 | 104, 168, 228 |
98 | brightmagenta | 13 | g:srcery_bright_magenta | #ff5c8f | 255, 92, 143 |
99 | brightcyan | 14 | g:srcery_bright_cyan | #2be4d0 | 43, 228, 208 |
100 | brightwhite | 15 | g:srcery_bright_white | #fce8c3 | 252, 232, 195 |
101
102 Additionally Srcery uses some xterm 256 colors to pad out the color selection,
103 no extra configuration needed.
104
105 | NAME | NR | VAR | HEX | RGB |
106 | ------------- | --- | ---------------------- | ------- | ----------- |
107 | orange | 202 | g:srcery_orange | #FF5F00 | 255, 95, 0 |
108 | bright_orange | 208 | g:srcery_bright_orange | #FF8700 | 255, 135, 0 |
109 | hard_black | 233 | g:srcery_hard_black | #121212 | 18, 18, 18 |
110 | xgray1 | 235 | g:srcery_xgray1 | #262626 | 38, 38, 38 |
111 | xgray2 | 236 | g:srcery_xgray2 | #303030 | 48, 48, 48 |
112 | xgray3 | 237 | g:srcery_xgray3 | #3A3A3A | 58, 58, 58 |
113 | xgray4 | 238 | g:srcery_xgray4 | #444444 | 68, 68, 68 |
114 | xgray5 | 239 | g:srcery_xgray5 | #4E4E4E | 78, 78, 78 |
115 | xgray6 | 240 | g:srcery_xgray6 | #585858 | 88, 88, 88 |
116
117 ==============================================================================
118 OPTIONS *srcery-options*
119
120 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:
122
123 >
124 let g:srcery_italic = 1
125 <
126
127 Make sure that you set these variables before assigning colorscheme.
128
129 g:srcery_[color] *srcery-option-color*
130
131 You can customize each of Srcery’s colors, to customize say the red color:
132 >
133 let g:srcery_red = '#FF0000'
134 <
135 Refer to the |srcery-color-table| for a full list of color variables, hexes
136 and more.
137
138 *srcery-option-bold*
139 g:srcery_bold
140
141 Enables bold text.
142
143 Default: 1
144
145 *srcery-option-italic*
146 g:srcery_italic
147
148 Enables italic text.
149
150 Default: gui 1, term 0
151
152 *srcery-option-underline*
153 g:srcery_underline
154
155 Enables underlined text.
156
157 Default: 1
158
159 *srcery-option-undercurl*
160 g:srcery_undercurl
161
162 Enables undercurled text.
163
164 Default: 1
165
166 *srcery-option-inverse*
167 g:srcery_inverse
168
169 Enable or disable inverse highlighting (foreground becomes background,
170 vice versa). This is used for visual selection, search highlights and
171 some other things.
172
173 Srcery will fall back to other methods of highlighting if this is
174 disabled.
175
176 Default: 1
177
178 *srcery-option-inverse-matches*
179 g:srcery_inverse_matches
180
181 Highlight search matches using inverse colors.
182
183 Default: 0
184
185 *srcery-option-inverse-match-paren*
186 g:srcery_inverse_match_paren
187
188 When enabled will highlight matching delimiters using inverse colors.
189 (`:DoMatchParen`)
190
191 Works best with Rainbow parenthesis.
192
193 Default: 0
194
195 *srcery-option-dim-lisp-paren*
196 g:srcery_dim_lisp_paren
197
198 Dims lisp dialects delimiters to a fairly dark gray (xgray5
199 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
213 Default: 0
214
215 *srcery-option-guisp-fallback*
216 g:srcery_guisp_fallback
217
218 Sets up alternate highlighting for colored underline/undercurl. Some
219 environments are unable to color underline, so this setting will set
220 either the background or foreground to whatever color the underline is
221 supposed to be.
222
223 This comes in handy if colored underline doesn’t work, or underline is
224 disabled entirely.
225
226 Default: `NONE`
227
228 Possible Values: `fg`, `bg`
229
230 *srcery-option-italic-types*
231 g:srcery_italic_types
232
233 Italicize types if italic is enabled.
234
235 Default: 0
236
237 *srcery-option-hard-black-terminal-bg*
238 g:srcery_hard_black_terminal_bg
239
240 If enabled, will set the terminal background in vim to hard black.
241 Note that this currently only works in Vim, not Neovim.
242
243 Default: 1
244
245 ==============================================================================
246 vim: tw=78:ts=8:ft=help:norl:noet:fen:noet :