2020-06-22 02:59:32 +00:00
# Default Settings Preview
2020-07-02 17:27:12 +00:00
2020-06-22 02:59:32 +00:00
2020-06-20 00:49:05 +00:00
# Introduction
2019-05-01 19:53:57 +00:00
2020-06-20 00:49:05 +00:00
`nvim-highlite` is a colorscheme template repository for Neovim 0.5+.
2019-05-01 19:53:57 +00:00
2020-06-22 01:43:51 +00:00
This template's focus is on compatability with [semantic highlighting ](https://medium.com/@evnbr/coding-in-color-3a6db2743a1e ).
2019-05-12 11:40:20 +00:00
2020-06-22 02:38:18 +00:00
It provides a large supply of defaults for plugins and programming languages as a result of defining a smaller set of "categorical" highlights (you can read more about this at Neovim's `group-name` help page).
2020-06-20 00:49:05 +00:00
# Prerequisites
2019-05-12 11:40:20 +00:00
2020-06-20 00:49:05 +00:00
1. Neovim 0.5+
2019-05-12 11:40:20 +00:00
2020-06-20 00:49:05 +00:00
# Usage
2019-05-12 11:40:20 +00:00
2020-06-22 02:38:18 +00:00
This repository should be cloned with `git clone https://github.com/Iron-E/nvim-highlite` , and then:
2019-05-01 19:53:57 +00:00
2020-06-20 00:49:05 +00:00
1. Rename `lua/highlite/` to `lua/<name of your colorscheme>/` .
2. Follow the directions in [lua/`<name of your colorscheme>`/init.lua ](lua/highlite/init.lua ).
3. Rename `colors/highlite.vim` to `colors/<name of your colorscheme>.vim` .
2020-06-20 03:53:31 +00:00
4. Follow the instructions in [colors/`<name of your colorscheme>`.vim ](colors/highlite.vim ).
2020-06-22 02:59:32 +00:00
5. Install the colorscheme:
* With a plugin manager (like [`vim-plug` ](https://github.com/junegunn/vim-plug )).
* By merging the [colors ](colors ) and [lua ](lua ) folders with the ones in your `stdpath('config')` directory.
6. Source with `colorscheme highlite` / `colorscheme <name of colorscheme>` in your [init.vim ]($HOME/.config/init.vim ).
2019-05-01 19:53:57 +00:00
2020-06-20 00:49:05 +00:00
## Examples
2019-05-01 19:53:57 +00:00
2020-06-20 03:53:31 +00:00
This repository in itself is an example of how to use `nvim-highlite` . Aside from this, the following colorschemes are built using `nvim-highlite` :
2019-05-01 19:53:57 +00:00
2020-06-20 00:49:05 +00:00
* (if you use this, open an issue and I'll add it here!)
