Skip to content

Commit 396e65c

Browse files
committed
docs: fix vim help docs
Match md readme with some rewritten sections docs: update vim help file, add introduction docs: add statusline section docs: fix alignment, headings, modeline docs: fix local-additions entry :help help-writing states that this should be srcery.txt + description check :help local-entries docs(modeline): rm dup, unneeded opts not sure why norl is there, the :help help-writing says it should just be filetype, textwidth and tabstop, I left noet because seems like tab is a thing in help syntax docs: rename heading + realign docs: fix heading
1 parent ef7ea19 commit 396e65c

2 files changed

Lines changed: 158 additions & 243 deletions

File tree

README.md

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,18 @@
1717
</a>
1818
</p>
1919
<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
2121
clearly defined contrasting colors with a pinch of earthly tint for that
2222
lived-in feel.
2323
</p>
2424

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+
2532
## Screenshots
2633

2734
| | | |
@@ -163,8 +170,36 @@ colorscheme srcery
163170

164171
## Configuration
165172

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+
166187
Make sure that you set these variables before assigning `colorscheme`.
167188

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+
168203
### Colors
169204

170205
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`
223258

224259
</details>
225260

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-
240261
## Statusline
241262

242263
Srcery supports several statuslines, they all follow the same coloring scheme

0 commit comments

Comments
 (0)