logan-connolly / gruvbox-material.nvim

Material Gruvbox colorscheme for Neovim written in Lua

Gruvbox Material Scheme

Note

This is a continuation of the original work from WittyJudge: https://github.com/WIttyJudge/gruvbox-material.nvim

A port of gruvbox-material colorscheme for Neovim written in Lua. It does not aim to be 100% compatible with the mentioned repository, but rather focuses on keeping the existing scheme stable and to support popular plugins. This colorscheme supports both dark and light themes, based on configured background.

Dark theme:

Light theme:

---

Table of Contents:

• Gruvbox Material Scheme
  • Features
  • Installation
  • Usage and Configuration

---

Features

• Supported Plugins:
  • Treesitter
  • Telescope
  • LSP Diagnostics
  • Nvim Tree
  • NERDTree
  • Startify
  • vim-gitgutter
  • undotree
  • Vista.vim
  • Hop
  • WhichKey
  • indentLine
  • Indent Blankline
  • nvim-notify
  • And many other plugins you can find here

Please feel free to open an issue if you want some features or other plugins to be included.

Installation

Note

This plugin requires Neovim >= 0.5.0

Install via your favourite package manager:

vim-plug

Plug 'f4z3r/gruvbox-material.nvim'

packer

use 'f4z3r/gruvbox-material.nvim'

lazy

{
  'f4z3r/gruvbox-material.nvim',
  name = 'gruvbox-material',
  lazy = false,
  priority = 1000,
  opts = {},
},

Usage and Configuration

Load the color scheme and define the desired options:

-- values shown are defaults and will be used if not provided
require('gruvbox-material').setup({
  italics = true,             -- enable italics in general
  comments = {
    italics = true,           -- enable italic comments
  },
  background = {
    transparent = false,      -- set the background to transparent
  },
  float = {
    force_background = false, -- force background on floats even when background.transparent is set
    background_color = nil,   -- set color for float backgrounds. If nil, uses the default color set
                              -- by the color scheme
  }
})