# 🎆 Mono Glow
A mostly monochrome colorscheme with a touch of glowing.
> [!NOTE]
> More 📷 [screenshots here](SCREENSHOTS.md)
## ✨ Features
- Supports the latest [Neovim](https://github.com/neovim/neovim)
[0.9.0](https://github.com/neovim/neovim/releases/tag/v0.9.0) features.
- Terminal colors.
- Supports ~all major~ plugins (see below).
> [!NOTE]
> Currently available Plugins and Extras are mostly based on what I use, but feel free
> to open an issue or a PR to suggest a new one!
🎨 Supported Plugins
| Plugin | Source |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| [blink.cmp](https://github.com/Saghen/blink.cmp) | [`blink-cmp`](lua/monoglow/groups/blink-cmp.lua) |
| [dashboard-nvim](https://github.com/nvimdev/dashboard-nvim) | [`dashboard`](lua/monoglow/groups/dashboard.lua) |
| [flash.nvim](https://github.com/folke/flash.nvim) | [`flash`](lua/monoglow/groups/flash.lua) |
| [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) | [`gitsigns`](lua/monoglow/groups/gitsigns.lua) |
| [markview.nvim](https://github.com/OXY2DEV/markview.nvim) | [`markview`](lua/monoglow/groups/markview.lua) |
| [mason.nvim](https://github.com/williamboman/mason.nvim) | [`mason`](lua/monoglow/groups/mason.lua) |
| [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim) | [`neo-tree`](lua/monoglow/groups/neo-tree.lua) |
| [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) | [`cmp`](lua/monoglow/groups/cmp.lua) |
| [nvim-window-picker](https://github.com/s1n7ax/nvim-window-picker) | [`nvim-window-picker`](lua/monoglow/groups/nvim-window-picker.lua) |
| [oil.nvim](https://github.com/stevearc/oil.nvim) | [`oil`](lua/monoglow/groups/oil.lua) |
| [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) | [`telescope`](lua/monoglow/groups/telescope.lua) |
| [which-key.nvim](https://github.com/folke/which-key.nvim) | [`which-key`](lua/monoglow/groups/which-key.lua) |
🍭 Extras
| Tool | Extra |
| -------------------------------------------------- | -------------------------------- |
| [Ghostty](https://ghostty.org/docs/features/theme) | [extras/ghostty](extras/ghostty) |
| [Helix](https://helix-editor.com/) | [extras/helix](extras/helix) |
| [Kitty](https://sw.kovidgoyal.net/kitty/conf.html) | [extras/kitty](extras/kitty) |
| [Vim](https://vimhelp.org/) | [extras/vim](extras/vim) |
| [VS Code](https://code.visualstudio.com/) | [extras/vscode](extras/vscode) |
| [WezTerm](https://wezterm.org/) | [extras/wezterm](extras/wezterm) |
| [Zed](https://zed.dev/) | [extras/zed](extras/zed) |
## 📦 Installation
Install the theme with your preferred package manager, such as
[folke/lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
"wnkz/monoglow.nvim",
lazy = false,
priority = 1000,
opts = {},
}
```
## 🚀 Usage
```lua
vim.cmd[[colorscheme monoglow]]
```
```vim
colorscheme monoglow
" There are also colorschemes for the different styles.
colorscheme monoglow-z
colorscheme monoglow-lack
colorscheme monoglow-void
colorscheme monoglow-light
```
## 🎨 Palette
> See [PALETTE.md](PALETTE.md) for all styles (z, lack, void, light) with WCAG contrast ratios.
## 🪓 Overriding Colors & Highlight Groups
How the highlight groups are calculated:
1. `colors` are determined based on your configuration, with the ability to
override them using `config.on_colors(colors)`.
1. These `colors` are utilized to generate the highlight groups.
1. `config.on_highlights(highlights, colors)` can be used to override highlight
groups.
For default values of `colors` and `highlights`, please consult the
[z](lua/monoglow/colors/z.lua),
[lack](lua/monoglow/colors/lack.lua),
[void](lua/monoglow/colors/void.lua), and
[light](lua/monoglow/colors/light.lua) palettes, as well as the
[base highlights](lua/monoglow/groups/base.lua).
Changing Colors
```lua
require("monoglow").setup({
-- Change the "glow" color
on_colors = function(colors)
colors.glow = "#fd1b7c"
end
})
```
Changing Highlight Styles
You can customize styles (italic, bold, etc.) for any highlight group using `on_highlights`.
> **Note:** `on_highlights` replaces the entire highlight definition. To preserve
> existing properties (like `fg`), include them in your override or use `vim.tbl_extend`.
```lua
require("monoglow").setup({
on_highlights = function(hl, c)
-- Override with full definition (recommended)
hl["@function"] = { fg = c.syntax.func_def, italic = true, bold = true }
hl.Boolean = { fg = c.syntax.boolean, bold = true, italic = true }
hl["@keyword"] = { fg = c.syntax.keyword, italic = true }
-- Or use vim.tbl_extend for partial overrides
hl.Comment = vim.tbl_extend("force", hl.Comment, { bold = true })
end,
})
```
See [`lua/monoglow/groups/base.lua`](lua/monoglow/groups/base.lua) and
[`lua/monoglow/groups/treesitter.lua`](lua/monoglow/groups/treesitter.lua) for
all available highlight groups.
## 🍭 Extras
Extra color configs for [Ghostty](extras/ghostty/), [Kitty](extras/kitty/), [Helix](extras/helix/), [Vim](extras/vim/), [VS Code](extras/vscode/), [WezTerm](extras/wezterm/), and [Zed](extras/zed/) can be found in [extras/](extras/).
To use them, refer to their respective documentation.
### Terminal Colors
## ☀️ Light Theme
A light variant is also available for those who prefer it.
## 🔥 Contributing
Pull requests are welcome.
## About
To build the colorscheme, I took everything I liked about the "colors" of [slugbyte/lackluster.nvim](https://github.com/slugbyte/lackluster.nvim),
I added the amazing touch of glow and bright operators from [Aliqyan-21/darkvoid.nvim](https://github.com/Aliqyan-21/darkvoid.nvim),
and I used [folke/tokyonight.nvim](https://github.com/folke/tokyonight.nvim) for the code structure.
## License
This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.
### Third-Party Acknowledgments
- Portions of this project include code derived from [tokyonight.nvim](https://github.com/folke/tokyonight.nvim), which is licensed under the Apache License, Version 2.0.
- Inspiration for colors and arrangement comes from [lackluster.nvim](https://github.com/slugbyte/lackluster.nvim) and [darkvoid.nvim](https://github.com/Aliqyan-21/darkvoid.nvim), both licensed under the MIT License.
See the [NOTICE](NOTICE) file for attributions and details.