
gruvbox.nvim
A port of [gruvbox community](https://github.com/gruvbox-community/gruvbox) theme to lua with [treesitter](https://github.com/nvim-treesitter/nvim-treesitter) support!
# Prerequisites
Neovim 0.7.0+
# Installing
Using `vim-plug`
```vim
Plug 'ellisonleao/gruvbox.nvim'
```
Using `packer`
```lua
use { "ellisonleao/gruvbox.nvim" }
```
# Basic Usage
Inside `init.vim`
```vim
set background=dark " or light if you want light mode
colorscheme gruvbox
```
Inside `init.lua`
```lua
vim.o.background = "dark" -- or "light" for light mode
vim.cmd([[colorscheme gruvbox]])
```
# Configuration
Additional settings for gruvbox are:
```lua
-- setup must be called before loading the colorscheme
-- Default options:
require("gruvbox").setup({
undercurl = true,
underline = true,
bold = true,
italic = true, -- will make italic comments and special strings
invert_selection = false,
invert_signs = false,
invert_tabline = false,
invert_intend_guides = false,
contrast = "hard", -- can be "hard" or "light"
overrides = {},
})
vim.cmd("colorscheme gruvbox")
```
## Overriding Highlight groups
If you don't enjoy the current color for a specific highlight group, now you can just override it in the setup. For
example:
```lua
require("gruvbox").setup({
overrides = {
SignColumn = {bg = "#ff9900"}
}
})
vim.cmd("colorscheme gruvbox")
```
Please note that the override values must follow the attributes from the highlight group map, such as:
- **fg** - foreground color
- **bg** - background color
- **bold** - true or false for bold font
- **italic** - true or false for italic font
Other values can be seen in `:h synIDattr`
# Additional supported plugins
- [vim-signify](https://github.com/mhinz/vim-signify)
- [vim-startify](https://github.com/mhinz/vim-startify)
- [lspsaga.nvim](https://github.com/glepnir/lspsaga.nvim)
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
And more..