|
17 | 17 | </a> |
18 | 18 | </p> |
19 | 19 | <p align="center"> |
20 | | - A ritualistic color scheme for (n)vim. Perform your dark magick using |
| 20 | + An occult color scheme for (n)vim. Perform your dark magick using |
21 | 21 | clearly defined contrasting colors with a pinch of earthly tint for that |
22 | 22 | lived-in feel. |
23 | 23 | </p> |
24 | 24 |
|
| 25 | +## Introduction |
| 26 | + |
| 27 | +Created using colors that logically adheres to the 16 color base palette of a |
| 28 | +given terminal, while trying to retain its own identity. The colors are |
| 29 | +designed to be easy on the eyes yet contrast well with the background for long |
| 30 | +sessions using an editor or terminal emulator. |
| 31 | + |
25 | 32 | ## Screenshots |
26 | 33 |
|
27 | 34 | | | | | |
@@ -163,8 +170,36 @@ colorscheme srcery |
163 | 170 |
|
164 | 171 | ## Configuration |
165 | 172 |
|
| 173 | +Srcery includes a few configuration options to customize your experience. To |
| 174 | +change any of these you’d put something like this in your `.vimrc` or |
| 175 | +`init.lua`: |
| 176 | + |
| 177 | +```vim |
| 178 | +" vimrc: |
| 179 | +let g:srcery_normal_float = 1 |
| 180 | +``` |
| 181 | + |
| 182 | +```lua |
| 183 | +-- init.lua: |
| 184 | +vim.g.srcery_normal_float = 1 |
| 185 | +``` |
| 186 | + |
166 | 187 | Make sure that you set these variables before assigning `colorscheme`. |
167 | 188 |
|
| 189 | +### Options |
| 190 | + |
| 191 | +|var|description|default| |
| 192 | +|---|-----------|-------| |
| 193 | +| `g:srcery_bold`| Enables **bold** text | `1` (enabled) | |
| 194 | +| `g:srcery_italic`| Enables *italic* text | `1` (enabled) | |
| 195 | +| `g:srcery_underline`| Enables <ins>underlined</ins> text | `1` (enabled) | |
| 196 | +| `g:srcery_undercurl` | Enables undercurled text | `1` (enabled) | |
| 197 | +| `g:srcery_strikethrough` | Enables ~~strikethrough~~ text | `1` (enabled) | |
| 198 | +| `g:srcery_inverse` | Enables inverse highlighting for visual selection, search, etc | `1` (enabled) | |
| 199 | +| `g:srcery_guisp_fallback` | Use alternate highlighting where colored underline/undercurl is unsupported. Set to either `'fg'` or `'bg'` | `'NONE'` (Disabled) | |
| 200 | +| `g:srcery_normal_float` | Use srcery colors for floating window background and border | `0` (disabled) | |
| 201 | + |
| 202 | + |
168 | 203 | ### Colors |
169 | 204 |
|
170 | 205 | You can customize each of Srcery's colors, to customize say the red color: |
@@ -223,20 +258,6 @@ instead of the default `g:srcery_black` |
223 | 258 |
|
224 | 259 | </details> |
225 | 260 |
|
226 | | -### Options |
227 | | - |
228 | | -|var|description|default| |
229 | | -|---|-----------|-------| |
230 | | -| `g:srcery_bold`| Enables **bold** text | `1` (enabled) | |
231 | | -| `g:srcery_italic`| Enables *italic* text | `1` (enabled) | |
232 | | -| `g:srcery_underline`| Enables <ins>underlined</ins> text | `1` (enabled) | |
233 | | -| `g:srcery_undercurl` | Enables undercurled text | `1` (enabled) | |
234 | | -| `g:srcery_strikethrough` | Enables ~~strikethrough~~ text | `1` (enabled) | |
235 | | -| `g:srcery_inverse` | Enables inverse highlighting for visual selection, search, etc | `1` (enabled) | |
236 | | -| `g:srcery_guisp_fallback` | Use alternate highlighting where colored underline/undercurl is unsupported. Set to either `'fg'` or `'bg'`, or `'NONE'` | `NONE` | |
237 | | -| `g:srcery_normal_float` | Use srcery colors for floating window background and border | `0` (disabled) | |
238 | | - |
239 | | - |
240 | 261 | ## Statusline |
241 | 262 |
|
242 | 263 | Srcery supports several statuslines, they all follow the same coloring scheme |
|
0 commit comments