aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 52046dd339ca6042eda928c07ff2a341de569c57 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# 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!

Please note that this plugin is under active development right now, so the status for it is still alpha. Please file issues if you find any bugs.

# Installing

Using `vim-plug`

```
Plug 'rktjmp/lush.nvim' # required
Plug 'npxbr/gruvbox.nvim'
```

Using `packer`

```
use {"npxbr/gruvbox.nvim", requires = {"rktjmp/lush.nvim"}}
```

# Usage

Inside `init.vim`

```vimscript
set background=dark " or light if you want light mode
set colorscheme=gruvbox
```

Inside `init.lua`
```lua
vim.o.background = "dark" -- or "light" for light mode
vim.cmd([[colorscheme gruvbox]])
```

# Configuration

all `g:gruvbox_` configs are the same [as the original one](https://github.com/morhetz/gruvbox/wiki/Configuration) except for `g:gruvbox_guisp_fallback`

# 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)

More to be added..