Skip to content
This repository has been archived by the owner on Jun 20, 2021. It is now read-only.

rafamadriz/gruvbox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gruvbox

2021-May-27_1

NOTE: this theme is only being updated on themes.nvim

Just another gruvbox theme.

✨ Features

  • Customizable.
  • Made to work with treesitter.
  • Support for built-in LSP.
  • Support for some of the most popular plugins.
  • Soft contrast for eye protection.
  • Multiple options to enable italic and bold text.
  • Vivid colors.

Requirements

NOTE: doesn't support Vim, it uses lua.

📦 Installation

Use your favorite plugin manager. Example packer:

use "rafamadriz/gruvbox"

🚀 Usage

Neovim

To set the theme you can use the following.

vim.cmd[[colorscheme gruvbox]]

To see all the available options do :help gruvbox-configuration in Neovim

⚙️ Configuration:

Note: the configuration options should be placed before vim.cmd[[colorscheme gruvbox]]

To see all the options from neovim, you can execute :help gruvbox.txt

Option Default Description
gruvbox_style "medium" options are "medium" and "hard"
gruvbox_italic_comment true Italic text for comments
gruvbox_italic_keyword false Applies to conditionals and keywords like for, do, while, loops etc.
gruvbox_italic_boolean false true and false
gruvbox_italic_function false Applies to function (calls and definitions), method (calls and definitions) and built-in functions.
gruvbox_italic_variable false Applies to variable names that are defined by the languages, like this or self. And any variable name that does not have another highlight group.
gruvbox_bold false Applies to error and warning messages, functions (calls and definitions), lsp virtual text, etc.

Example config:

vim.g.gruvbox_italic_keyword = true
vim.g.gruvbox_italic_function = true

vim.cmd[[colorscheme gruvbox]]

FAQ

It doesn't work as expected.

  1. This color scheme is mainly designed for true colors, make sure of setting: vim.o.termguicolors = true

  2. To test if your terminal supports true colors, use the following script.

  3. This colorscheme is made to look good with treesitter, if you don't have it, it won't look the same as the screenshoots.

How to enable cursive italic keywords?

  1. Install a font that supports italics, for example JetBrains-NerdFont is an excellent font.

  2. Set the correct italic font for your terminal of choice.

  3. Enable italic text. E.g. vim.g.gruvbox_italic_keyword = true

Supported plugins:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published