paper-tonic/README.md

40 lines
1.7 KiB
Markdown
Raw Normal View History

2020-06-22 02:59:32 +00:00
# Default Settings Preview
2020-07-02 17:27:12 +00:00
![lua preview](./media/preview.png "Lua Preview")
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-08-28 18:34:45 +00:00
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.
2020-07-02 17:37:37 +00:00
* I use `redshift` often, and many colorschemes did not allow for me to see when I had lower color temperatures.
2019-05-12 11:40:20 +00:00
2020-08-28 18:34:45 +00:00
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.
2020-06-22 02:38:18 +00:00
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-07-02 17:40:01 +00:00
This repository should be cloned with `git clone https://github.com/Iron-E/nvim-highlite`, and then follow the instructions in [`colors/highlite.vim`](colors/highlite.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!)