152 lines
8.7 KiB
Markdown
152 lines
8.7 KiB
Markdown
# Default Settings Preview
|
|
|
|
|
|
|
|
# Introduction
|
|
|
|
`nvim-highlite` is a colorscheme template repository for Neovim 0.5+.
|
|
|
|
This template's _defaults_ focus on:
|
|
|
|
1. Compatability with [semantic highlighting](https://medium.com/@evnbr/coding-in-color-3a6db2743a1e).
|
|
* I was using colorschemes that often did not provide enough highlight groups to provide distinction between tokens.
|
|
2. Visibility in any range of blue-light.
|
|
* I use `redshift` often, and many colorschemes did not allow for me to see when I had lower color temperatures.
|
|
|
|
This template's _design_ focuses on:
|
|
|
|
1. Ease of use and rapid development.
|
|
* New features may simply be integrated with current configurations, rather than rewritten over them.
|
|
* Merging with the upstream repository is simplified by GitHub, allowing you to select what new defaults to add.
|
|
* It provides a large supply of defaults for plugins and programming languages.
|
|
* Define a smaller set of "categorical" highlights (see Neovim's `group-name` help page) and many more will `link` automatically.
|
|
2. Inversion of Control
|
|
* Changes made to the highlighting algorithm won't affect how you write your colorscheme.
|
|
* New highlight group attributes which are unaccounted for in older versions will simply be ignored without errors due to Lua's `table`s.
|
|
|
|
# Prerequisites
|
|
|
|
1. Neovim 0.5+
|
|
|
|
# Installation
|
|
|
|
## Creating Your Own
|
|
|
|
1. This repository should be forked, or cloned with `git clone https://github.com/Iron-E/nvim-highlite`.
|
|
2. Follow the instructions in [`colors/highlite.vim`](colors/highlite.vim).
|
|
* If you are on a Unix system, use the [setup script](setup.sh) like so:
|
|
```sh
|
|
chmod +x ./setup.sh
|
|
./setup.sh highlite <colorscheme>
|
|
```
|
|
Where `<colorscheme>` is the name of your desired colorscheme.
|
|
* If you are on Windows, rename the files manually.
|
|
|
|
## Just The Defaults
|
|
|
|
1. Install a plugin manager such as [`vim-plug`](https://github.com/junegunn/vim-plug) and use it to "plug" this repository.
|
|
```viml
|
|
" vim-plug example
|
|
Plug "Iron-E/nvim-highlite"
|
|
```
|
|
2. Specify this colorscheme as your default colorscheme in the `init.vim`:
|
|
```viml
|
|
" Enable 24-bit color output. Only do this if your environment supports it.
|
|
" This plugin works 100% fine with 8-bit, 16-bit, and 24-bit colors.
|
|
set termguicolors
|
|
" Use the colorscheme
|
|
colorscheme highlite
|
|
```
|
|
|
|
# Usage
|
|
|
|
## Examples
|
|
|
|
This repository in itself is an example of how to use `nvim-highlite`. Aside from this, the following colorschemes are built using `nvim-highlite`:
|
|
|
|
* (if you use this, open an issue and I'll add it here!)
|
|
|
|
```lua
|
|
--[[Keep in mind, the following example is meant to be used within the context of the `colors/highlite.vim` file.]]
|
|
-- First, define some colors
|
|
local red = {'#FF0000', 1, 'red'}
|
|
local black = {'#000000', 0, 'black'}
|
|
local white = {'#FFFFFF', 255, 'white'}
|
|
|
|
-- Next define some highlight groups.
|
|
local highlight_groups = {
|
|
-- Any field which can be set to "NONE" doesn't need to be set, it will be automatically assumed to be "NONE".
|
|
Identifier = {bg=red, fg=black, style='bold'},
|
|
-- If you want to have a colorscheme which is responsive to multiple background settings, you can do that too:
|
|
Function = {dark={bg=black}, light={bg=white}, fg=red}
|
|
--[[ Note that light/dark differentiation is completely optional. ]]
|
|
}
|
|
|
|
-- The rest is mostly handled by the template.
|
|
```
|
|
|
|
## FAQ
|
|
|
|
> Why am I receiving `E5108: Error executing lua [string ":lua"]:1: module '<colorscheme>' not found`?
|
|
|
|
Ensure your colorscheme's base folder is in Neovim's `rtp` before sourcing.
|
|
|
|
> What syntax files should I use for `X` language?
|
|
|
|
You can either use [`nvim-treesitter`](https://github.com/nvim-treesitter/nvim-treesitter), or one of the following:
|
|
|
|
| Language | Syntax Plugin |
|
|
|:-----------|:--------------------------------------------------------------------------------------------|
|
|
| ALGOL | [`sterpe/vim-algol68`](https://github.com/sterpe/vim-algol68) |
|
|
| C++ | [`bfrg/vim-cpp-modern`](https://github.com/bfrg/vim-cpp-modern) |
|
|
| Dart | [`dart-lang/dart-vim-plugin`](https://github.com/dart-lang/dart-vim-plugin) |
|
|
| DTrace | [`vim-scripts/dtrace-syntax-file`](https://github.com/vim-scripts/dtrace-syntax-file) |
|
|
| F# | [`ionide/Ionide-vim`](https://github.com/ionide/Ionide-vim) |
|
|
| Gas | [`Shirk/vim-gas`](https://github.com/Shirk/vim-gas) |
|
|
| Git | [`tpope/vim-git`](https://github.com/tpope/vim-git) |
|
|
| Go | [`fatih/vim-go`](https://github.com/fatih/vim-go) |
|
|
| GraphViz | [`liuchengxu/graphviz`](https://github.com/liuchengxu/graphviz) |
|
|
| HTML5 | [`othree/html5`](https://github.com/othree/html5) |
|
|
| i3conf | [`mboughaba/i3config`](https://github.com/mboughaba/i3config) |
|
|
| JSON | [`elzr/vim-json`](https://github.com/elzr/vim-json) |
|
|
| Java | [`uiiaoo/java-syntax`](https://github.com/uiiaoo/java-syntax) |
|
|
| JavaScript | [`pangloss/vim-javascript`](https://github.com/pangloss/vim-javascript) |
|
|
| Julia | [`JuliaEditorSupport/julia-vim`](https://github.com/JuliaEditorSupport/julia-vim) |
|
|
| Kotlin | [`udalov/kotlin-vim`](https://github.com/udalov/kotlin-vim) |
|
|
| LESS | [`groenewege/vim-less`](https://github.com/groenewege/vim-less) |
|
|
| LLVM | [`rhysd/vim-llvm`](https://github.com/rhysd/vim-llvm) |
|
|
| Lua | [`tbastos/vim-lua`](https://github.com/tbastos/vim-lua) |
|
|
| Markdown | [`plasticboy/vim-markdown`](https://github.com/plasticboy/vim-markdown) |
|
|
| MIPS | [`vim-scripts/mips`](https://github.com/vim-scripts/mips) |
|
|
| Moonscript | [`leafo/moonscript-vim`](https://github.com/leafo/moonscript-vim) |
|
|
| PlantUML | [`aklt/plantuml-syntax`](https://github.com/aklt/plantuml-syntax) |
|
|
| Prettier | [`prettier/vim-prettier`](https://github.com/prettier/vim-prettier) |
|
|
| Python | [`vim-python/python-syntax`](https://github.com/vim-python/python-syntax) |
|
|
| Razor | [`adamclerk/vim-razor`](https://github.com/adamclerk/vim-razor) |
|
|
| RST | [`marshallward/vim-restructuredtext`](https://github.com/marshallward/vim-restructuredtext) |
|
|
| Ruby | [`vim-ruby/vim-ruby`](https://github.com/vim-ruby/vim-ruby) |
|
|
| SCSS | [`cakebaker/scss-syntax`](https://github.com/cakebaker/scss-syntax) |
|
|
| SQL | [`shmup/vim-sql-syntax`](https://github.com/shmup/vim-sql-syntax) |
|
|
| Shell | [`arzg/vim-sh`](https://github.com/arzg/vim-sh) |
|
|
| Stylus | [`wavded/vim-stylus`](https://github.com/wavded/vim-stylus) |
|
|
| SystemD | [`wgwoods/vim-systemd-syntax`](https://github.com/wgwoods/vim-systemd-syntax) |
|
|
| SystemTap | [`nickhutchinson/vim-systemtap`](https://github.com/nickhutchinson/vim-systemtap) |
|
|
| TOML | [`cespare/vim-toml`](https://github.com/cespare/vim-toml) |
|
|
| TeX | [`lervag/vimtex`](https://github.com/lervag/vimtex) |
|
|
| Ungrammar | [`Iron-E/vim-ungrammar`](https://github.com/Iron-E/vim-ungrammar) |
|
|
| VB.NET | [`vim-scripts/vbnet`](https://github.com/vim-scripts/vbnet) |
|
|
| Vim Logs | [`MTDL9/vim-log-highlighting`](https://github.com/MTDL9/vim-log-highlighting) |
|
|
| Vimscript | [`vim-jp/syntax-vim-ex`](https://github.com/vim-jp/syntax-vim-ex) |
|
|
| XML | [`amadeus/vim-xml`](https://github.com/amadeus/vim-xml) |
|
|
| YAML | [`stephpy/vim-yaml`](https://github.com/stephpy/vim-yaml) |
|
|
| YATS | [`HerringtonDarkholme/yats`](https://github.com/HerringtonDarkholme/yats) |
|
|
|
|
# Contribution
|
|
|
|
This repository is looking for contributions! The following things are appreciated:
|
|
|
|
* [ ] More default support for plugins, languages, etc.
|
|
* [ ] Setup scripts for Windows.
|
|
|
|
If you would like to contribute something, and you aren't sure how, open a ticket! I'd love to help you help me.
|