gruvbox README

The project's README from github.com/morhetz/gruvbox. As one markdown file: README.md.

gruvbox is heavily inspired by badwolf, jellybeans and solarized.

Designed as a bright theme with pastel 'retro groove' colors and light/dark mode switching in the way of solarized. The main focus when developing gruvbox is to keep colors easily distinguishable, contrast enough and still pleasant for the eyes.

Attention

  1. Read this first
  2. Typeface from gallery is Fantasque Sans Mono
  3. Typeface from screenshots below is Fira Mono

Screenshots

Refer Gallery for more syntax-specific screenshots.

Dark mode

Screenshot Dark

Light mode

Screenshot Light

Airline theme

Screenshot Airline

Palette

Dark mode

Palette Dark

Light mode

Palette Light

Contrast options

Refer wiki section for contrast configuration and other options.

Contrast Options

Documentation

Please check wiki for installation details, terminal-specific setup, troubleshooting, configuration options and others.

Features

Contributions

See gruvbox-contrib repo for contributions, ports and extras.

ToDo

Self-Promotion

If you like gruvbox follow the repository on GitHub and vote for it on vim.org.

License

MIT/X11

gruvbox (morhetz/gruvbox)

Searching Database…

15.8K ·GitHub
What is this?Gruvbox is a retro-groove color scheme for Vim, designed with bright pastel colors and both light and dark mode switching, similar in philosophy to Solarized.
Is this a Vim plugin or a standalone app?It is a Vim colorscheme plugin written in Vim Script, meant to be installed into your Vim/Neovim configuration like any other plugin.
How do I install and activate it?Install it with your preferred Vim plugin manager and then set 'colorscheme gruvbox' in your vimrc; the wiki has full installation and terminal-specific setup details.
Do I need any extra tools to use it?Just Vim or Neovim; no external dependencies are required, though the screenshots use fonts like Fantasque Sans Mono and Fira Mono for display.
Are there any filetypes or plugins it doesn't support yet?Syntax highlighting for R, TeX, Swift and Erlang is not yet implemented, and support for plugins like Tagbar and VimPlug is still on the to-do list.
Which syntaxes and plugins does it already support out of the box?It extends highlighting for Html, Xml, Vim, Clojure, C, Python, JavaScript, TypeScript, PureScript, CoffeeScript, Ruby, Objective-C, Go, Lua, MoonScript, Java, Markdown, Haskell and Elixir, plus plugins like Airline, Lightline, GitGutter, Syntastic, Ale, CtrlP, NERDTree and more.
Can I customize the contrast or invert colors?Yes, gruvbox offers lots of style-customization options including contrast level, color inversion and italics usage, configurable via wiki options.
Is there a companion project for extra ports and integrations?Yes, the 'gruvbox-contrib' repository collects community contributions, ports to other tools, and extras built around the gruvbox palette.
Does it support the Airline status line theme?Yes, gruvbox ships with its own Airline theme alongside dark and light mode palettes.
What inspired the gruvbox color palette?It was heavily inspired by the Badwolf, Jellybeans, and Solarized color schemes, combining their best traits into a pastel retro-groove look.
Creator
morhetz
Size
6.7 MB
Stars
15.8K
Age
13y
Commits · 90 Days