diff vendor/vim-packs/srcery-vim/doc/srcery.txt @ 726:78469331407e

Update syntaxes
author nanaya <me@nanaya.net>
date Mon, 19 Aug 2024 17:04:13 +0900
parents 1e0f578f6752
children
line wrap: on
line diff
--- a/vendor/vim-packs/srcery-vim/doc/srcery.txt	Mon Aug 19 17:03:52 2024 +0900
+++ b/vendor/vim-packs/srcery-vim/doc/srcery.txt	Mon Aug 19 17:04:13 2024 +0900
@@ -9,29 +9,30 @@
 CONTENTS						*srcery-contents*
 
 Introduction				|srcery-introduction|
-Installation 				|srcery-installation|
-	Vim 8 				|srcery-install-vim8|
-	Dein 				|srcery-install-dein|
-	Pathogen 			|srcery-install-pathogen|
-	Plug 				|srcery-install-plug|
-Color Table 				|srcery-color-table|
+Installation				|srcery-installation|
+	Vim 8				|srcery-install-vim8|
+	Dein				|srcery-install-dein|
+	Pathogen			|srcery-install-pathogen|
+	Plug				|srcery-install-plug|
+Color Table				|srcery-color-table|
 Options					|srcery-options|
-	g:srcery_[color] 		|srcery-option-color|
-	g:srcery_bold 			|srcery-option-bold|
-	g:srcery_italic 		|srcery-option-italic|
-	g:srcery_underline 		|srcery-option-underline|
-	g:srcery_undercurl 		|srcery-option-undercurl|
-	g:srcery_inverse 		|srcery-option-inverse|
-	g:srcery_inverse_matche 	|srcery-option-inverse-matches|
-	g:srcery_inverse_match_paren 	|srcery-option-inverse-match-paren|
-	g:srcery_dim_lisp_paren 	|srcery-option-dim-lisp-paren|
-	g:srcery_bg_passthrough 	|srcery-option-bg-passthrough|
-	g:srcery_guisp_fallback 	|srcery-option-guisp-fallback|
-	g:srcery_italic_types 		|srcery-option-italic-types|
-	g:srcery_hard_black_terminal_bg |srcery-option-hard-black-terminal-bg|
+	g:srcery_[color]		|srcery-option-color|
+	g:srcery_bold			|srcery-option-bold|
+	g:srcery_italic			|srcery-option-italic|
+	g:srcery_underline		|srcery-option-underline|
+	g:srcery_undercurl		|srcery-option-undercurl|
+	g:srcery_strikethrough		|srcery-option-strikethrough|
+	g:srcery_inverse		|srcery-option-inverse|
+	g:srcery_inverse_matche		|srcery-option-inverse-matches|
+	g:srcery_inverse_match_paren	|srcery-option-inverse-match-paren|
+	g:srcery_dim_lisp_paren		|srcery-option-dim-lisp-paren|
+	g:srcery_guisp_fallback		|srcery-option-guisp-fallback|
+	g:srcery_italic_types		|srcery-option-italic-types|
+	g:srcery_bg			|srcery-option-bg|
+	g:srcery_hard_black_terminal_bg	|srcery-option-hard-black-terminal-bg|
 
 ==============================================================================
-INTRODUCTION 						   *srcery-introduction*
+INTRODUCTION						   *srcery-introduction*
 
 Created using colors that logically adheres to the 16 color base palette of a
 given terminal, while trying to retain its own identity. The colors are
@@ -41,23 +42,31 @@
 ==============================================================================
 INSTALLATION						   *srcery-installation*
 
-Put srcery.vim in `~/.vim/colors/` (on unix-like systems) or
-`%userprofile%\vimfiles\colors\` (on Windows).
+Download or clone srcery's repository to a location of your choosing and set
+your 'runtimepath' correctly, otherwise srcery will not work as it relies on
+'autoload' functionality.
+
+You can also install with your favourite plugin manager.
 
 							   *srcery-install-vim8*
 
-Vim 8 has native support for loading plugins. All you need to do to is to
-clone this repository into `~/.vim/plug/default/opt`.
+Vim 8 has native support for loading plugins by using |packages|. All you need
+to do to, is to clone this repository into `~/.vim/pack/themes/opt`.
 >
 	git clone https://github.com/srcery-colors/srcery-vim \
-		~/.vim/plug/default/opt
+		~/.vim/pack/themes/opt
+<
+And then set your `.vimrc` accordingly.
+>
+	packadd! srcery-vim
+	colorscheme srcery
 <
 
 The same works for Neovim, but you have to clone it into a path where Neovim
 can find it.
 >
 	git clone https://github.com/srcery-colors/srcery-vim \
-		~/.config/nvim/plug/default/opt
+		$XDG_CONFIG_HOME/nvim/pack/themes/opt
 <
 
 							   *srcery-install-dein*
@@ -80,24 +89,24 @@
 ==============================================================================
 COLOR TABLE						    *srcery-color-table*
 
-| termcol       | nr | var                       | hex     | rgb           |
-| ------------- | -- | ------------------------- | ------- | ------------- |
-| black         | 0  | g:srcery_black            | #1c1b19 | 28,  27,  25  |
-| red           | 1  | g:srcery_red              | #ef2f27 | 239, 47, 39   |
-| green         | 2  | g:srcery_green         	 | #519f50 | 81,  159, 80  |
-| yellow        | 3  | g:srcery_yellow        	 | #fbb829 | 251, 184, 41  |
-| blue          | 4  | g:srcery_blue          	 | #2c78bf | 44, 120, 191  |
-| magenta       | 5  | g:srcery_magenta       	 | #e02c6d | 224, 44,  109 |
-| cyan          | 6  | g:srcery_cyan          	 | #0aaeb3 | 10, 174, 179  |
-| white         | 7  | g:srcery_white         	 | #baa67f | 186, 166, 127 |
-| brightblack   | 8  | g:srcery_bright_black  	 | #918175 | 145, 129, 117 |
-| brightred     | 9  | g:srcery_bright_red    	 | #f75341 | 247, 83, 65   |
-| brightgreen   | 10 | g:srcery_bright_green  	 | #98bc37 | 152, 188, 55  |
-| brightyellow  | 11 | g:srcery_bright_yellow 	 | #fed06e | 254, 208, 110 |
-| brightblue    | 12 | g:srcery_bright_blue   	 | #68a8e4 | 104, 168, 228 |
-| brightmagenta | 13 | g:srcery_bright_magenta	 | #ff5c8f | 255, 92, 143  |
-| brightcyan    | 14 | g:srcery_bright_cyan   	 | #2be4d0 | 43, 228, 208  |
-| brightwhite   | 15 | g:srcery_bright_white  	 | #fce8c3 | 252, 232, 195 |
+| TERMCOL       | NR | VAR                     | HEX     | RGB           |
+| ------------- | -- | ----------------------- | ------- | ------------- |
+| black         | 0  | g:srcery_black          | #1C1B19 | 28,  27,  25  |
+| red           | 1  | g:srcery_red            | #EF2F27 | 239, 47, 39   |
+| green         | 2  | g:srcery_green          | #519F50 | 81,  159, 80  |
+| yellow        | 3  | g:srcery_yellow         | #FBB829 | 251, 184, 41  |
+| blue          | 4  | g:srcery_blue           | #2C78BF | 44, 120, 191  |
+| magenta       | 5  | g:srcery_magenta        | #E02C6D | 224, 44,  109 |
+| cyan          | 6  | g:srcery_cyan           | #0AAEB3 | 10, 174, 179  |
+| white         | 7  | g:srcery_white          | #BAA67F | 186, 166, 127 |
+| brightblack   | 8  | g:srcery_bright_black   | #918175 | 145, 129, 117 |
+| brightred     | 9  | g:srcery_bright_red     | #F75341 | 247, 83, 65   |
+| brightgreen   | 10 | g:srcery_bright_green   | #98BC37 | 152, 188, 55  |
+| brightyellow  | 11 | g:srcery_bright_yellow  | #FED06E | 254, 208, 110 |
+| brightblue    | 12 | g:srcery_bright_blue    | #68A8E4 | 104, 168, 228 |
+| brightmagenta | 13 | g:srcery_bright_magenta | #FF5C8F | 255, 92, 143  |
+| brightcyan    | 14 | g:srcery_bright_cyan    | #2BE4D0 | 43, 228, 208  |
+| brightwhite   | 15 | g:srcery_bright_white   | #FCE8C3 | 252, 232, 195 |
 
 Additionally Srcery uses some xterm 256 colors to pad out the color selection,
 no extra configuration needed.
@@ -119,11 +128,9 @@
 
 Srcery includes a few toggles due to discrepancies in the various setups
 possible. To change any of these you’d put something like this in your .vimrc:
-
 >
 	let g:srcery_italic = 1
 <
-
 Make sure that you set these variables before assigning colorscheme.
 
 g:srcery_[color] 					   *srcery-option-color*
@@ -132,6 +139,11 @@
 >
 	let g:srcery_red = '#FF0000'
 <
+Inside a 256-color terminal emulator, additional colors are configurable
+via setting the corresponding variable with the _cterm suffix, e.g.
+>
+	let g:srcery_hard_black_cterm = 232
+<
 Refer to the |srcery-color-table| for a full list of color variables, hexes
 and more.
 
@@ -163,6 +175,13 @@
 
 	Default: 1
 
+						   *srcery-option-strikethrough*
+g:srcery_strikethrough
+
+	Enables strikethrough text.
+
+	Default: 1
+
 							 *srcery-option-inverse*
 g:srcery_inverse
 
@@ -192,7 +211,7 @@
 
 	Default: 0
 
-					 	  *srcery-option-dim-lisp-paren*
+						  *srcery-option-dim-lisp-paren*
 g:srcery_dim_lisp_paren
 
 	Dims lisp dialects delimiters to a fairly dark gray (xgray5
@@ -200,18 +219,6 @@
 
 	Default: 0
 
-						  *srcery-option-bg-passthrough*
-g:srcery_bg_passthrough
-
-	Lets the terminal control the background color in Vim by setting the
-	background NONE.
-
-	A possible use case for this could be you want to manipulate the
-	background color in the terminal, and let the results bubble up to
-	Vim.
-
-	Default: 0
-
  						  *srcery-option-guisp-fallback*
 g:srcery_guisp_fallback
 
@@ -234,9 +241,27 @@
 
 	Default: 0
 
+							      *srcery-option-bg*
+g:srcery_bg
+
+	Let's you customize the background color. This var takes a list with
+	two values, with a quoted HEX in the first position, and a terminal
+	color index for the second position. This lets you set both a 24-bit
+	color, and a 8bit terminal color index.
+
+	You can specify `'NONE'` as one of the values to make it transparent,
+	as such `['NONE', 'NONE']` would be the same as the previous option
+	`g:srcery_bg_passthrough = 1`.
+
+
+	You can specify `'DEFAULT'` as one of the values in order to use that
+	position's default value.
+
+	Default: `[g:srcery_black, 0]`
+
 					  *srcery-option-hard-black-terminal-bg*
 g:srcery_hard_black_terminal_bg
-	
+
 	If enabled, will set the terminal background in vim to hard black.
 	Note that this currently only works in Vim, not Neovim.