435 lines
17 KiB
Lua
435 lines
17 KiB
Lua
--[[ Highlite, a Neovim colorscheme template.
|
||
* Author: Iron-E (https://github.com/Iron-E)
|
||
* Repository: https://github.com/nvim-highlite
|
||
|
||
Rewrite of RNB, a Vim colorsheme template.
|
||
* Author: Romain Lafourcade (https://github.com/romainl)
|
||
* Canonical URL: https://github.com/romainl/vim-rnb
|
||
]]
|
||
|
||
--[[ Introduction
|
||
This template is designed to help vimmers create their own colorschemes
|
||
without much effort.
|
||
|
||
You will not need any additional tooling to run this file. Just open it
|
||
in Neovim and follow the instructions— the colorscheme will generate
|
||
be generated automatically.
|
||
|
||
The process is divided in five steps:
|
||
1. Rename the template,
|
||
2. Edit your colorscheme's information,
|
||
3. Define your colors,
|
||
4. Define your highlight groups and links, and
|
||
5. Sourcing your colorscheme.
|
||
]]
|
||
|
||
--[[ Step 1: renaming
|
||
If this file is distributed with a colorscheme it's probably already named correctly
|
||
and you can skip this step.
|
||
|
||
If you forked/cloned/copied this repository to create your own colorscheme, you will have to
|
||
rename this template to match the name of your colorscheme.
|
||
|
||
NOTE: Neovim doesn't really care about whitespace in the name of the colorscheme but it does for
|
||
filenames so make sure your filename doesn't have any whitespace character.
|
||
|
||
| colorscheme name | template filename |
|
||
|:-----------------:|:-----------------:|
|
||
| foobar | foobar.lua |
|
||
| foo-bar | foo-bar.lua |
|
||
| foo bar | foo-bar.lua or |
|
||
| foo_bar | foo_bar.lua |
|
||
]]
|
||
|
||
--[[ Step 2: information
|
||
Make sure the name of your colorscheme is unique and attractive.
|
||
]]
|
||
|
||
local name = "highlite"
|
||
|
||
--[[ Step 3: colors
|
||
Next you will define all of the colors that you will use for the color scheme.
|
||
|
||
Each one should be made up of three parts:
|
||
|
||
```lua
|
||
<color name> = { -- Give each color a distinctive name.
|
||
<hex color code>, -- Hexadecimal color used in GVim/MacVim or "NONE".
|
||
<256-bit color code>, -- Integer 0–255 used by terminals supporting 256 colors or "NONE".
|
||
<16-bit color code> -- color name used by less capable color terminals, can be "darkred",
|
||
"red", "darkgreen", "green", "darkyellow", "yellow", "darkblue",
|
||
"blue", "darkmagenta", "magenta", "black", "darkgrey", "grey",
|
||
"white", or "NONE"
|
||
}
|
||
```
|
||
|
||
If your colors are defined correctly, the resulting colorscheme is guaranteed
|
||
to work in GVim (Windows/Linux), MacVim (MacOS), and any properly set up terminal emulator.
|
||
]]
|
||
|
||
local black = {"#202020", 0, "black"}
|
||
local gray = {"#808080", 244, "gray" }
|
||
local gray_dark = {"#353535", 236, "darkgrey"}
|
||
local gray_darker = {"#505050", 244, "gray" }
|
||
local gray_light = {"#c0c0c0", 251, "gray" }
|
||
local white = {"#ffffff", 15, "white"}
|
||
|
||
local brown_light = {"#fca070", 178, "darkyellow"}
|
||
local tan = {"#f4c069", 180, "darkyellow"}
|
||
|
||
local red = {"#ee4a59", 196, "red"}
|
||
local red_dark = {"#a80000", 124, "darkred"}
|
||
local red_light = {"#ff4090", 203, "red"}
|
||
|
||
local orange = {"#ff8900", 208, "darkyellow"}
|
||
local orange_light = {"#f0af00", 214, "yellow"}
|
||
|
||
local yellow = {"#f0df33", 220, "yellow"}
|
||
|
||
local green_dark = {"#50de60", 83, "darkgreen"}
|
||
local green = {"#77ff00", 72, "green"}
|
||
local green_light = {"#a0ff70", 72, "green"}
|
||
|
||
local blue = {"#7090ff", 63, "darkblue"}
|
||
local cyan = {"#00efff", 87, "cyan"}
|
||
local ice = {"#80b5ff", 63, "cyan"}
|
||
local teal = {"#6ac0c0", 38, "cyan"}
|
||
local turqoise = {"#2bff99", 33, "blue"}
|
||
|
||
local magenta = {"#d5508f", 126, "magenta"}
|
||
local magenta_dark = {"#bb0099", 126, "darkmagenta"}
|
||
local pink = {"#ffa6ff", 162, "magenta"}
|
||
local pink_light = {"#ffb7b7", 38, "white"}
|
||
local purple = {"#cf55f0", 129, "magenta"}
|
||
local purple_light = {"#af60af", 63, "magenta"}
|
||
local purple_dark = {"#c700ff", 38, "darkmagenta"}
|
||
|
||
--[[ Step 4: highlights
|
||
You can define highlight groups like this:
|
||
|
||
```lua
|
||
<highlight group name> = {
|
||
bg=<color>, -- The color used for background color, or use "NONE", "fg" or "bg"
|
||
fg=<color>, -- The color used for foreground color, or use "NONE", "fg" or "bg"
|
||
-- Style can be "bold", "italic", and more. See |attr-list| for more information.
|
||
style=<cterm>
|
||
-- style can also have a color, and/or multiple <cterm>s.
|
||
style={<cterm> [, <cterm>] [color=<color>]})
|
||
}
|
||
```
|
||
|
||
The sample above tells Vim to render normal text in dark gray against a white
|
||
background, without any other styling.
|
||
|
||
Or you can link an highlight group to another. Here, "Title" will inherit its style from
|
||
"Normal":
|
||
|
||
```lua
|
||
Title = {link="Normal"}
|
||
```
|
||
|
||
In GUI Vim, there is an additional color for the undercurl used to
|
||
highlight spelling mistakes:
|
||
|
||
```lua
|
||
SpellBad = { -- ← name of the highlight group
|
||
bg="NONE", -- background color
|
||
fg=red, -- foureground color
|
||
style={ -- the style
|
||
"undercurl", -- undercurl (squiggly line)
|
||
color=red -- the color of the undercurl
|
||
}
|
||
}
|
||
```
|
||
|
||
If you weren't satisfied with undercurl, and also wanted another effect, you can
|
||
add another one below "undercurl" and it will be applied as well:
|
||
|
||
```lua
|
||
SpellBad = { -- ← name of the highlight group
|
||
bg="NONE", -- background color
|
||
fg=red, -- foureground color
|
||
style={ -- the style
|
||
"undercurl", -- undercurl (squiggly line)
|
||
"standout"
|
||
color=red -- the color of the undercurl
|
||
}
|
||
}
|
||
```
|
||
|
||
The sample above tells Vim to render badly spelled words in red against the current
|
||
background, with a red undercurl.
|
||
|
||
You can add any custom highlight group to the standard list below but you shouldn't
|
||
remove any if you want a working colorscheme. Most of them are described under
|
||
:help highlight-default, the others are taken from :help group-name. Both help sections
|
||
are good reads, by the way.
|
||
]]
|
||
|
||
-- This is the only highlight that must be defined separately.
|
||
local Normal = {bg=black, fg=gray_light, style="NONE"}
|
||
|
||
-- This is where the rest of your highlights should go.
|
||
local highlights = {
|
||
--[[ 1. Text Analysis ]]
|
||
Comment = {bg="NONE", fg=gray, style="italic"},
|
||
EndOfBuffer = {link="NonText" },
|
||
NonText = {bg="NONE", fg=gray_dark, style="NONE" },
|
||
Whitespace = {link="NonText" },
|
||
|
||
--[[ 1.1. Literals]]
|
||
Constant = {bg="NONE", fg=orange_light, style="NONE"},
|
||
String = {bg="NONE", fg=green, style="NONE"},
|
||
Character = {bg="NONE", fg=red_light, style="NONE"},
|
||
Number = {bg="NONE", fg=pink_light, style="NONE"},
|
||
Boolean = {bg="NONE", fg=yellow, style="NONE"},
|
||
Float = {link="Number" },
|
||
|
||
--[[ 1.2. Identifiers]]
|
||
Identifier = {bg="NONE", fg="fg", style="NONE"},
|
||
Function = {bg="NONE", fg=purple, style="NONE"},
|
||
|
||
--[[ 1.3. Syntax]]
|
||
Statement = {bg="NONE", fg=ice, style="NONE" },
|
||
Conditional = {bg="NONE", fg=ice, style="italic"},
|
||
Repeat = {link="Keyword" },
|
||
Label = {bg="NONE", fg=pink, style="italic"},
|
||
Operator = {bg="NONE", fg=green_dark, style="NONE" },
|
||
Keyword = {bg="NONE", fg=turqoise, style="bold" },
|
||
Exception = {bg="NONE", fg=red, style="bold" },
|
||
|
||
--[[ 1.4. Metatextual Information]]
|
||
PreProc = {bg="NONE", fg=tan, style="NONE" },
|
||
Include = {bg="NONE", fg=green_light, style="nocombine"},
|
||
Define = {bg="NONE", fg=blue, style="nocombine"},
|
||
Macro = {link='Define' },
|
||
PreCondit = {bg="NONE", fg=teal, style="nocombine"},
|
||
|
||
--[[ 1.5. Semantics]]
|
||
Type = {bg="NONE", fg=cyan, style="NONE" },
|
||
StorageClass = {bg="NONE", fg=orange_light, style="bold" },
|
||
Structure = {bg="NONE", fg=blue, style="bold" },
|
||
Typedef = {bg="NONE", fg=cyan, style="italic"},
|
||
|
||
--[[ 1.6. Edge Cases]]
|
||
Special = {bg="NONE", fg=magenta, style="NONE"},
|
||
SpecialChar = {link="Character" },
|
||
SpecialKey = {link="Character" },
|
||
Tag = {link="Underlined" },
|
||
Delimiter = {bg="NONE", fg=white, style="NONE"},
|
||
SpecialComment = {bg="NONE", fg=gray, style="bold"},
|
||
Debug = {link='WarningMsg' },
|
||
|
||
--[[ 1.7. Help Syntax]]
|
||
Underlined = {bg="NONE", fg=turqoise, style="underline" },
|
||
Ignore = {bg="NONE", fg=gray, style="NONE" },
|
||
Error = {bg=red_dark, fg=white, style="bold" },
|
||
Todo = {bg="NONE", fg=yellow, style={"bold", "underline"}},
|
||
helpHyperTextJump = {link="Underlined" },
|
||
helpSpecial = {link="Function" },
|
||
|
||
--[[ 2... Editor UI ]]
|
||
--[[ 2.1. Status Line]]
|
||
StatusLine = {bg=gray_darker, fg=green_light, style="NONE"},
|
||
StatusLineNC = {bg=gray_darker, fg=gray, style="NONE"},
|
||
StatusLineTerm = {link="StatusLine" },
|
||
StatusLineTermNC = {link="StatusLineNC" },
|
||
|
||
--[[ 2.2. Separators]]
|
||
VertSplit = {bg="NONE", fg=gray_darker, style="NONE" },
|
||
TabLine = {bg=gray_darker, fg="fg", style="NONE" },
|
||
TabLineFill = {bg="NONE", fg="fg", style="NONE" },
|
||
TabLineSel = {bg=gray_darker, fg="fg", style="inverse"},
|
||
Title = {bg="NONE", fg="NONE", style="bold" },
|
||
|
||
--[[ 2.3. Conditional Line Highlighting]]
|
||
--Conceal={}
|
||
CursorLine = {bg=gray_dark, fg="NONE", style="NONE" },
|
||
CursorLineNr = {bg=gray_dark, fg=pink, style="NONE" },
|
||
debugBreakpoint = {link="ErrorMsg" },
|
||
debugPC = {link="ColorColumn" },
|
||
LineNr = {bg="NONE", fg=gray, style="NONE" },
|
||
QuickFixLine = {bg=gray_darker, fg="NONE", style="NONE" },
|
||
Visual = {bg="NONE", fg="NONE", style="inverse"},
|
||
VisualNOS = {bg=gray_darker, fg="NONE", style="NONE" },
|
||
|
||
--[[ 2.4. Popup Menu]]
|
||
Pmenu = {bg=gray_dark, fg="fg", style="NONE"},
|
||
PmenuSbar = {bg=black, fg="NONE", style="NONE"},
|
||
PmenuSel = {bg="NONE", fg="fg", style="NONE"},
|
||
PmenuThumb = {bg=white, fg="NONE", style="NONE"},
|
||
WildMenu = {bg="NONE", fg="NONE", style="NONE"},
|
||
|
||
--[[ 2.5. Folds]]
|
||
FoldColumn = {bg=gray_darker, fg="NONE", style="bold" },
|
||
Folded = {bg=purple_light, fg=black, style="italic"},
|
||
|
||
--[[ 2.6. Diffs]]
|
||
DiffAdd = {bg="NONE", fg=green_dark, style="inverse"},
|
||
DiffChange = {bg="NONE", fg=yellow, style="inverse"},
|
||
DiffDelete = {bg="NONE", fg=red, style="inverse"},
|
||
DiffText = {bg="NONE", fg="NONE", style="inverse"},
|
||
|
||
--[[ 2.7. Searching]]
|
||
IncSearch = {bg="NONE", fg="NONE", style="inverse" },
|
||
Search = {bg="NONE", fg="NONE", style={"undercurl", color=white}},
|
||
MatchParen = {bg="NONE", fg=green, style="bold,underline" },
|
||
|
||
--[[ 2.8. Spelling]]
|
||
SpellBad = {bg="NONE", fg="NONE", style={"undercurl", color=red }},
|
||
SpellCap = {bg="NONE", fg="NONE", style={"undercurl", color=yellow}},
|
||
SpellLocal = {bg="NONE", fg="NONE", style={"undercurl", color=green }},
|
||
SpellRare = {bg="NONE", fg="NONE", style={"undercurl", color=orange}},
|
||
|
||
--[[ 2.9. Conditional Column Highlighting]]
|
||
ColorColumn = {bg="NONE", fg="NONE", style="inverse"},
|
||
SignColumn = {bg="NONE", fg="NONE", style="NONE" },
|
||
|
||
--[[ 2.10. Messages]]
|
||
ErrorMsg = {bg="NONE", fg=red_light, style="bold"},
|
||
ModeMsg = {bg="NONE", fg=yellow, style="NONE"},
|
||
WarningMsg = {bg="NONE", fg=orange, style="bold"},
|
||
Question = {bg="NONE", fg=orange_light, style="underline"},
|
||
|
||
--[[ 2.11. Cursor ]]
|
||
--Cursor = {},
|
||
--CursorIM = {link="Cursor"},
|
||
CursorColumn = {bg=gray_dark, fg="NONE", style="NONE"},
|
||
|
||
-- 2.12 Misc.
|
||
Directory = {bg="NONE", fg=ice, style="bold"},
|
||
Terminal = {link="Normal" },
|
||
|
||
--[[ 3. Plugin Highlight Groups ]]
|
||
-- By default, this section is empty, but feel free to add your own information here.
|
||
}
|
||
|
||
--[[
|
||
Define the color palette used by :terminal when in GUI Vim
|
||
or in TUI Vim when 'termguicolors' is enabled. If this list
|
||
is empty or if it doesn't contain exactly 16 items, the corresponding
|
||
Vim variable won't be set.
|
||
|
||
The expected values are colors defined in step 3.
|
||
|
||
Terminal emulators use a basic palette of 16 colors that can be
|
||
addressed by CLI and TUI tools via their name or their index, from
|
||
0 to 15. The list is not really standardized but it is generally
|
||
assumed to look like this:
|
||
|
||
| Index | Name |
|
||
|:------:|:-------------:|
|
||
| 1 | black |
|
||
| 2 | darkred |
|
||
| 3 | darkgreen |
|
||
| 4 | darkyellow |
|
||
| 5 | darkblue |
|
||
| 6 | darkmagenta |
|
||
| 7 | darkcyan |
|
||
| 8 | gray |
|
||
| 9 | darkgray |
|
||
| 10 | red |
|
||
| 11 | green |
|
||
| 12 | yellow |
|
||
| 13 | blue |
|
||
| 14 | magenta |
|
||
| 15 | cyan |
|
||
| 16 | white |
|
||
|
||
While you are certainly free to make colors 0 to 7 shades of blue,
|
||
this will inevitably cause usability issues so… be careful.
|
||
]]
|
||
|
||
local terminal_ansi_colors = {
|
||
[1] = black,
|
||
[2] = red_dark,
|
||
[3] = green_dark,
|
||
[4] = orange,
|
||
[5] = blue,
|
||
[6] = magenta_dark,
|
||
[7] = teal,
|
||
[8] = gray,
|
||
[9] = gray_dark,
|
||
[10] = red,
|
||
[11] = green,
|
||
[12] = yellow,
|
||
[13] = turqoise,
|
||
[14] = purple,
|
||
[15] = cyan,
|
||
[16] = gray_light
|
||
}
|
||
|
||
--[[ Step 5: Sourcing
|
||
When you wish to load your colorscheme, you will not use the `colorscheme` command like normal.
|
||
|
||
Instead, you will source this file with `:luafile stdpath('config') . '/lua/<filename>.lua'`
|
||
|
||
See `:help luafile` and `:help stdpath` for more information.
|
||
|
||
These online resources can help you design your colorscheme:
|
||
|
||
1. the xterm palette.
|
||
* http://upload.wikimedia.org/wikipedia/en/1/15/Xterm_256color_chart.svg
|
||
2. play with hexadecimal colors right in the address bar (currently down).
|
||
* http://whatcolor.herokuapp.com/
|
||
3. similar concept, fuzzier implementation.
|
||
* http://color.hailpixel.com/
|
||
4. similar concept, fancier implementation.
|
||
* http://colourco.de/
|
||
5. extract a palette from an image.
|
||
* http://www.colr.org/
|
||
6. search for 'word', get images and color palettes.
|
||
* http://colores.manugarri.com/
|
||
7. user-created palettes.
|
||
* http://www.colourlovers.com/palettes
|
||
8. a no-nonsense colorscheme generator.
|
||
* http://www.pluaang.dk/color+scheme/
|
||
9. Adobe's fancy colorscheme generator.
|
||
* https://color.adobe.com/
|
||
10. The classic 'Color Scheme Designer', rebranded.
|
||
* http://paletton.com/
|
||
11. A very smart palette generator.
|
||
* http://vrl.cs.brown.edu/color
|
||
12. "I Made My Own Colour Scheme and You Can Too!".
|
||
* https://cmcenroe.me/2018/04/03/colour-scheme.html
|
||
|
||
A few general advices:
|
||
|
||
* The Windows console is limited to the 16 so-called "ANSI" colors but it used to
|
||
have a few of them interverted which makes numbers impractical. Use color names
|
||
instead of numbers: :help cterm-colors
|
||
* The Windows console (yeah…) doesn't do italics, underlines or bolded text;
|
||
it is limited to normal and reverse. Keep that in mind if you want
|
||
your colorscheme to be usable in as many environments as possible by as many
|
||
people as possible.
|
||
* Actually, terminal emulators rarely do italics.
|
||
* The Windows Terminal, however, is capable of more.
|
||
* All of the terminal emulators in use these days allow their users to
|
||
change the 16 so-called "ANSI" colors. It is also possible on some platforms
|
||
to change some or all of the 256 colors in the xterm palette. Don't take
|
||
anything for granted.
|
||
* When used against a light background, strong colors work better than muted
|
||
ones. Light or dark doesn't really matters. Also, it is harder to discriminate
|
||
between two similar colors on a light background.
|
||
* Both strong and muted colors work well against a dark background. It is also
|
||
easier to work with similar colors, but dark colors don't work at all.
|
||
* Use as many text samples as possible. String-heavy languages may look completely
|
||
different than keyword-heavy ones. This can have an impact on the usability
|
||
of your colorscheme.
|
||
* Most terminal emulators and terminal multiplexers currently in use on unix-like
|
||
systems support 256 colors but they almost always default to a '$TERM' that tells
|
||
Vim otherwise. Your users will need to make sure their terminal emulator/multiplexer
|
||
is correctly set up if they want to enjoy the best possible experience.
|
||
|
||
Many thanks to Barry Arthur (https://github.com/dahu) for the original idea.
|
||
|
||
* You don't need to edit anything beyond this line. *
|
||
]]
|
||
|
||
require(name .. '/colorscheme')(
|
||
name,
|
||
Normal,
|
||
highlights,
|
||
terminal_ansi_colors
|
||
)
|