Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shatur/neovim-ayu
Ayu theme for Neovim.
https://github.com/shatur/neovim-ayu
neovim neovim-colorscheme neovim-theme vim-colorscheme
Last synced: 13 days ago
JSON representation
Ayu theme for Neovim.
- Host: GitHub
- URL: https://github.com/shatur/neovim-ayu
- Owner: Shatur
- License: gpl-3.0
- Created: 2021-05-02T22:10:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-08T14:50:37.000Z (2 months ago)
- Last Synced: 2024-10-19T02:55:40.468Z (27 days ago)
- Topics: neovim, neovim-colorscheme, neovim-theme, vim-colorscheme
- Language: Lua
- Homepage:
- Size: 1.58 MB
- Stars: 426
- Watchers: 5
- Forks: 43
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Neovim Ayu
A colorscheme for Neovim reimplemented in lua from [ayu-vim](https://github.com/Luxed/ayu-vim).
## Screenshots
## Commands
To apply the colorscheme, you can call `require('ayu').colorscheme()` from lua or use `:colorscheme ayu` command. By default it respects your `'background'` (see `:h background`) setting to choose between `dark` and `light` variants. But you can use the `:colorscheme ayu-dark`, `:colorscheme ayu-light`, or `:colorscheme ayu-mirage` commands to apply a variant directly.
## Configuration
To configure the plugin, you can call `require('ayu').setup(values)`, where `values` is a dictionary with the parameters you want to override. Here are the defaults:
```lua
require('ayu').setup({
mirage = false, -- Set to `true` to use `mirage` variant instead of `dark` for dark background.
terminal = true, -- Set to `false` to let terminal manage its own colors.
overrides = {}, -- A dictionary of group names, each associated with a dictionary of parameters (`bg`, `fg`, `sp` and `style`) and colors in hex.
})
```
Alternatively, `overrides` can be a function that returns a dictionary of the same format. You can use the function to override based on a dynamic condition, such as the value of `'background'`.
Colorscheme also provides a theme for [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim). You can set in `setup` lualine:
```lua
require('lualine').setup({
options = {
theme = 'ayu',
},
})
```
### Overrides examples
#### Transparency
```lua
require('ayu').setup({
overrides = {
Normal = { bg = "None" },
ColorColumn = { bg = "None" },
SignColumn = { bg = "None" },
Folded = { bg = "None" },
FoldColumn = { bg = "None" },
CursorLine = { bg = "None" },
CursorColumn = { bg = "None" },
WhichKeyFloat = { bg = "None" },
VertSplit = { bg = "None" },
},
})
```
**Tip:** You can use `:source $VIMRUNTIME/syntax/hitest.vim` to see all highlighting groups.
#### Re-use colors from the colorscheme
```lua
local colors = require('ayu.colors')
colors.generate() -- Pass `true` to enable mirage
require('ayu').setup({
overrides = {
IncSearch = { fg = colors.fg }
}
})
```
**Tip:** You can use `:lua print(vim.inspect(require('ayu.colors')))` command to check all available colors.
#### Set background color of non-active windows for both light and dark backgrounds
In this case you need to use a function to dynamically generate colors:
```lua
require('ayu').setup({
overrides = function()
if vim.o.background == 'dark' then
return { NormalNC = {bg = '#0f151e', fg = '#808080'} }
else
return { NormalNC = {bg = '#f0f0f0', fg = '#808080'} }
end
end
})
```
**Tip:** If you use `ayu.colors` as in the example above, you don't need to check for `vim.o.background`, but you still need to use a function.
#### Disable _italic_ for comments
```lua
local colors = require('ayu.colors')
colors.generate() -- Pass `true` to enable mirage
require('ayu').setup({
overrides = function()
return { Comment = { fg = colors.comment } }
end
})
```