apetribegames/gruvbox-material

Gruvbox with Material Palette

Introduction

Gruvbox Material is a modified version of Gruvbox, the contrast is adjusted to be softer in order to protect developers' eyes.

There are 3 palettes available in this color scheme:

material: Carefully designed to have a soft contrast (click on this line to preview)

	𝐃𝐚𝐫𝐤	𝐋𝐢𝐠𝐡𝐭
𝐇𝐚𝐫𝐝
𝐌𝐞𝐝𝐢𝐮𝐦
𝐒𝐨𝐟𝐭

mix: Color palette obtained by calculating the mean of the other two (click on this line to preview)

	𝐃𝐚𝐫𝐤	𝐋𝐢𝐠𝐡𝐭
𝐇𝐚𝐫𝐝
𝐌𝐞𝐝𝐢𝐮𝐦
𝐒𝐨𝐟𝐭

original: The color palette used in the original gruvbox (click on this line to preview)

	𝐃𝐚𝐫𝐤	𝐋𝐢𝐠𝐡𝐭
𝐇𝐚𝐫𝐝
𝐌𝐞𝐝𝐢𝐮𝐦
𝐒𝐨𝐟𝐭

This color scheme uses the material palette by default, you can use a global variable to switch to another palette.

Features

• Carefully designed color palette for eye protection.
• Switch back to the original color palette whenever you like.
• Highly customizable.
• Rich support for common file types and plugins.
• Italic support 🎉

Installation

Via Plugin Manager

Take vim-plug for example:

Plug 'sainnhe/gruvbox-material'

For better syntax highlighting support, please install sheerun/vim-polyglot or nvim-treesitter/nvim-treesitter.

Via Pack Feature

1. Create a new directory: $ mkdir -p ~/.vim/pack/colors/opt
2. Clone this repository: $ git clone --depth 1 https://github.com/sainnhe/gruvbox-material.git ~/.vim/pack/colors/opt/gruvbox-material
3. Generate help tags: :helptags ~/.vim/pack/colors/opt/gruvbox-material/doc/
4. Add packadd! gruvbox-material to your vimrc.

Note: If you install this color scheme to pack/*/start, you still need to add packadd! gruvbox-material to your vimrc. sainnhe/gruvbox-material#60

Manually

1. Clone this repository.
2. Copy /path/to/gruvbox-material/autoload/gruvbox_material.vim to ~/.vim/autoload/.
3. Copy /path/to/gruvbox-material/colors/gruvbox-material.vim to ~/.vim/colors/ .
4. Copy /path/to/gruvbox-material/doc/gruvbox-material.txt to ~/.vim/doc/ and execute :helptags ~/.vim/doc/ to generate help tags.
5. To install airline theme, copy /path/to/gruvbox-material/autoload/airline/themes/gruvbox_material.vim to ~/.vim/autoload/airline/themes/ .
6. To install lightline theme, copy /path/to/gruvbox-material/autoload/lightline/colorscheme/gruvbox_material.vim to ~/.vim/autoload/lightline/colorscheme/ .

AUR

There are some packages available for Arch Linux users in AUR:

• vim-gruvbox-material-git
• neovim-gruvbox-material-git

Usage

See :help gruvbox-material.txt

Related Projects

See this wiki page.

More Color Schemes

• Everforest
• Edge
• Sonokai

Credits

• The color palette is based on gruvbox by @morhetz
• The color palette is adjusted by @sainnhe

Inspirations

• morhetz/gruvbox: original gruvbox
• atom.io: the white color in the dark variant
• zefei/cake16: the black color in the light variant
• Google Material Design

Maintainers

Sainnhe Park	Zixin Yin

License

MIT © sainnhe