@@ -7,9 +7,11 @@ Color scheme with clearly defined contrasting colors and a slightly earthy tone.
7
7
## Requirements
8
8
9
9
### GUI
10
- You don’t need to do anything for this colorscheme to work in GVim or MacVim.
10
+
11
+ You don’t need to do anything for this colorscheme to work in gVim or MacVim.
11
12
12
13
### TUI
14
+
13
15
To use Srcery in the terminal you need to change your terminal emulator’s
14
16
so-called “ASCII” colors to the ones in the table below. There's a list of
15
17
terminal configurations in the
@@ -53,6 +55,7 @@ to pad out the color selection, no extra configuration needed.
53
55
## Installation
54
56
55
57
### Manually
58
+
56
59
Put ` srcery.vim ` in ` ~/.vim/colors/ ` (on unix-like systems) or ` %userprofile%\vimfiles\colors\ ` (on Windows).
57
60
58
61
### Vim 8
@@ -62,27 +65,42 @@ this repository into `~/.vim/plug/default/opt`.
62
65
63
66
git clone https://github.com/srcery-colors/srcery-vim ~/.vim/plug/default/opt
64
67
65
- The same works for NeoVim , but you have to clone it into a path where NeoVim can
68
+ The same works for Neovim , but you have to clone it into a path where Neovim can
66
69
find it.
67
70
68
71
git clone https://github.com/srcery-colors/srcery-vim ~/.config/nvim/plug/default/opt
69
72
70
73
### [ dein.vim] ( https://github.com/Shougo/dein.vim )
74
+
71
75
``` vim
72
76
call dein#add('srcery-colors/srcery-vim')
73
77
```
74
78
75
79
### [ vim-pathogen] ( https://github.com/tpope/vim-pathogen )
80
+
76
81
``` shell
77
82
cd ~ /.vim/bundle
78
83
git clone https://github.com/srcery-colors/srcery-vim
79
84
```
80
85
81
86
### [ vim-plug] ( https://github.com/junegunn/vim-plug )
87
+
82
88
``` vim
83
89
Plug 'srcery-colors/srcery-vim'
84
90
```
85
91
92
+ ## Usage
93
+
94
+ ```
95
+ :color srcery
96
+ ```
97
+
98
+ If you like what you see and decide to make srcery your default colorscheme, add the relevant line to your ` .vimrc ` :
99
+
100
+ ``` vim
101
+ colorscheme srcery
102
+ ```
103
+
86
104
## Configuration
87
105
88
106
Srcery includes a few toggles due to discrepancies in the various setups possible.
@@ -94,39 +112,45 @@ let g:srcery_italic = 1
94
112
95
113
Make sure that you set these variables before assigning ` colorscheme ` .
96
114
97
- #### Colors
115
+ ### Colors
98
116
99
117
You can customize each of Srcery's colors, to customize say the red color:
118
+
100
119
``` vim
101
120
let g:srcery_red = '#FF0000'
102
121
```
103
122
104
123
Refer to the [ table] ( #TUI ) for a full list of color variables, hexes and more.
105
124
106
- This will only work on ` set termguicolors ` and in Gvim , to override terminal
125
+ This will only work on ` set termguicolors ` and in gVim , to override terminal
107
126
colors, do so in your [ terminal
108
127
configuration] ( https://github.com/srcery-colors/srcery-terminal ) .
109
128
129
+ ### Options
110
130
111
131
#### g: srcery_bold
112
132
113
133
Enables bold text.
114
- default: 1
134
+
135
+ Default: 1
115
136
116
137
#### g: srcery_italic
117
138
118
139
Enables italic text.
119
- default: gui 1, term 0
140
+
141
+ Default: gui 1, term 0
120
142
121
143
#### g: srcery_underline
122
144
123
145
Enables underlined text.
124
- default: 1
146
+
147
+ Default: 1
125
148
126
149
#### g: srcery_undercurl
127
150
128
151
Enables undercurled text.
129
- default: 1
152
+
153
+ Default: 1
130
154
131
155
#### g: srcery_inverse
132
156
@@ -137,41 +161,40 @@ some other things.
137
161
Srcery will fall back to other methods of highlighting if this is
138
162
disabled.
139
163
140
- default : 1
164
+ Default : 1
141
165
142
166
#### g: srcery_inverse_matches
143
167
144
- Highlight search matches using inverse colors
168
+ Highlight search matches using inverse colors.
145
169
146
- default : 0
170
+ Default : 0
147
171
148
172
#### g: srcery_inverse_match_paren
149
173
150
174
When enabled will highlight matching delimiters using inverse colors.
151
175
(` :DoMatchParen ` )
152
176
153
- Works best with [ Rainbow parenthesis] ( https://github.com/kien/rainbow_parentheses.vim )
177
+ Works best with [ Rainbow parenthesis] ( https://github.com/kien/rainbow_parentheses.vim ) .
154
178
155
- default : 0
179
+ Default : 0
156
180
157
181
#### g: srcery_dim_lisp_paren
158
182
159
- Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically)
183
+ Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically).
160
184
161
- default : 0
185
+ Default : 0
162
186
163
187
#### g: srcery_bg_passthrough
164
188
165
- Lets the terminal control the background color in Vim, setting the background
166
- in vim to NONE.
189
+ Lets the terminal control the background color in Vim by setting the background to ` NONE ` .
167
190
168
191
A possible use case for this could be you want to manipulate the background
169
192
color in the terminal, and let the results bubble up to Vim, like [ this] ( https://github.com/roosta/tmux-pop ) .
170
193
171
194
This is a bit of an experimental option, and can cause issues in certain
172
195
terminals.
173
196
174
- default : 0
197
+ Default : 0
175
198
176
199
#### g: srcery_guisp_fallback
177
200
@@ -182,27 +205,18 @@ background or foreground to whatever color the underline is supposed to be.
182
205
This comes in handy if colored underline doesn't work, or underline is disabled
183
206
entirely.
184
207
185
- default : 'NONE'
208
+ Default : 'NONE'
186
209
187
- possible Values: 'fg', 'bg'
210
+ Possible Values: 'fg', 'bg'
188
211
189
212
#### g: srcery_italic_types
190
213
191
- Italicize types if italic is enabled
192
-
193
- default: 0
214
+ Italicize types if italic is enabled.
194
215
216
+ Default: 0
195
217
196
- ## Usage
197
- ```
198
- :color srcery
199
- ```
200
-
201
- If you like what you see and decide to make srcery your default colorscheme, add the relevant line to your vimrc:
202
- ``` vim
203
- colorscheme srcery
204
- ```
205
218
## Screenshots
219
+
206
220
viml, bash
207
221
![ viml_bash] ( https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/viml_bash.png )
208
222
@@ -218,12 +232,12 @@ python, js
218
232
git, terminal
219
233
![ git_term] ( https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/git_term.png )
220
234
221
-
222
235
Typeface used in screenshots is [ Iosevka] ( https://github.com/be5invis/Iosevka )
223
236
224
237
## Plugin support
225
238
226
239
### Lightline
240
+
227
241
![ lightline] ( https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/lightline.png )
228
242
229
243
[ Lightline] ( https://github.com/itchyny/lightline.vim ) colorscheme.
@@ -236,6 +250,7 @@ let g:lightline = {
236
250
```
237
251
238
252
### Airline
253
+
239
254
![ airline] ( https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/airline.png )
240
255
241
256
Thanks to [ MindTooth] ( https://github.com/MindTooth ) , Srcery now includes an [ Airline] ( https://github.com/vim-airline/vim-airline ) theme.
@@ -277,6 +292,7 @@ Srcery:
277
292
### Colors don't look right
278
293
279
294
Ensure that 256 colors are enabled in vim by setting this option ** before** setting the colorscheme.
295
+
280
296
``` viml
281
297
set t_Co=256
282
298
```
0 commit comments