rayelliott
/
paper-tonic
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
paper-tonic/README.md

229 lines
11 KiB
Markdown
Raw Blame History

# nvim-paper-tonic
## Default Settings Preview
![lua preview](https://user-images.githubusercontent.com/36409591/128422684-f51354e9-e895-493e-8e7d-db7bb08eb735.png "Lua Preview")
## Introduction
`nvim-paper-tonic` 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.
## Installation
The only prerequisite is Neovim 0.5+
### Creating Your Own
1. Fork this repository, or clone it with `git clone https://github.com/Iron-E/nvim-paper-tonic`.
2. Follow the instructions in [`colors/paper-tonic.vim`](colors/paper-tonic.vim).
* If you are on a Unix system, use the [setup script](setup.sh) like so:
```sh
chmod +x ./setup.sh
./setup.sh paper-tonic <colorscheme>
```
Where `<colorscheme>` is the name of your desired colorscheme.
* If you are on Windows, rename the files manually.
Whenever you want to update from then on, you can run the [update script](update.sh). This will load the latest upstream changes to the core highlighting library.
### Just The Defaults
1. Install a plugin manager such as [`packer.nvim`](https://github.com/wbthomason/packer.nvim):
```lua
-- packer.nvim example
local fn = vim.fn
local install_path = fn.stdpath('data')..'/site/pack/packer/opt/packer.nvim'
if not vim.loop.fs_stat(fn.glob(install_path)) then
os.execute('git clone https://github.com/wbthomason/packer.nvim '..install_path)
end
vim.api.nvim_command 'packadd packer.nvim'
return require('packer').startup {function(use)
use {'wbthomason/packer.nvim', opt=true}
use 'Iron-E/nvim-paper-tonic'
end}
```
2. Specify this colorscheme as your default colorscheme in the `init.vim`:
```vim
" Enable 24-bit color output. Only do this IF your environment supports it.
" This plugin is fully compatible with 8-bit, 16-bit, and 24-bit colors.
set termguicolors
" Use the colorscheme
colorscheme paper-tonic
```
Or using `init.lua`:
```lua
vim.opt.termguicolors = true
vim.api.nvim_command 'colorscheme paper-tonic'
```
## Usage
This repository in itself is an example of how to use `nvim-paper-tonic`. Aside from this, the following colorschemes are built using `nvim-paper-tonic`:
* (if you use this, open an issue and I'll add it here!)
### As Dependency
Below is an example of how to use `nvim-paper-tonic` as a dependency.
* See `:h paper-tonic-usage` for more.
```lua
-- Import nvim-paper-tonic
local paper-tonic = require('paper-tonic')
-- First, define some colors
local red = {'#FF0000', 1, 'red'}
local black = {'#000000', 0, 'black'}
local white = {'#FFFFFF', 255, 'white'}
-- Highlight 'Identifier'
paper-tonic.highlight('Identifier', {bg=red, fg=black, style='bold'})
-- Highlight 'Function' conditionally according to background color.
paper-tonic.highlight('Function', {bg=black, fg=red, light={bg=white}})
-- Link 'Example' to 'Identifier'
paper-tonic.highlight('Example', 'Identifier')
-- You can also reference specific attributes of another highlight group.
paper-tonic.highlight('AnotherExample', {bg=paper-tonic.group'SpellBad'.bg, fg=white})
```
### As Template
Below is an example of how to use `nvim-paper-tonic` as a template.
* See [`paper-tonic.vim`](colors/paper-tonic.vim) for more.
```lua
-- 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 your colorscheme should respond to multiple background settings, you can do that too:
Function = {bg=black, fg=red, light={bg=white}},
--[[ Note that light/dark differentiation is completely optional. ]]
-- You can also reference specific attributes of another highlight group.
SomethingElse = function(self) return {fg=self.Identifier.fg, bg=self.Function.bg} end,
}
-- The rest is mostly handled by the template.
```
## FAQ
> How can I override the highlighting of one specific highlight group in my `init.vim`?
When using this plugin, it is important to know that you can't just run `:hi` on a highlight group and expect that its changes will be retained. You must attach them to the `ColorScheme` `autocmd` event, as shown below:
```vim
packadd nvim-paper-tonic
set termguicolors "optional
" WRONG! Don't do this.
hi! Error guifg=#000000 guibg=#FFFFFF
" Do this instead.
augroup Highlite
" You can also use `paper-tonic.highlight()` instead of `:hi!`
autocmd ColorScheme paper-tonic hi! Error guifg=#000000 guibg=#FFFFFF
augroup end
colorscheme paper-tonic
```
Of course, substitute `paper-tonic` with the name of your colorscheme.
> 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), [`vim-polyglot`](https://github.com/sheerun/vim-polyglot), or some 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) |
| Coq | [whonore/Coqtail](https://github.com/whonore/Coqtail) |
| 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) |
| Java | [Iron-E/java-syntax](https://github.com/Iron-E/java-syntax) |
| JavaScript | [pangloss/vim-javascript](https://github.com/pangloss/vim-javascript) |
| JSON | [elzr/vim-json](https://github.com/elzr/vim-json) |
| 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 | [jlcrochet/vim-razor](https://github.com/jlcrochet/vim-razor) |
| RST | [marshallward/vim-restructuredtext](https://github.com/marshallward/vim-restructuredtext) |
| Ruby | [vim-ruby/vim-ruby](https://github.com/vim-ruby/vim-ruby) |
| Rust | [Iron-E/rust.vim](https://github.com/Iron-E/rust.vim) |
| SCSS | [cakebaker/scss-syntax](https://github.com/cakebaker/scss-syntax) |
| Shell | [arzg/vim-sh](https://github.com/arzg/vim-sh) |
| SQL | [shmup/vim-sql-syntax](https://github.com/shmup/vim-sql-syntax) |
| 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) |
| TeX | [lervag/vimtex](https://github.com/lervag/vimtex) |
| TOML | [cespare/vim-toml](https://github.com/cespare/vim-toml) |
| 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) |
| 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.
Reference in New Issue View Git Blame Copy Permalink