111 lines
3.7 KiB
Markdown
111 lines
3.7 KiB
Markdown
|
<p align="center"><img src="http://imgh.us/gruvbox_logo.svg"></p>
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
[badwolf]: https://github.com/sjl/badwolf
|
||
|
|
[jellybeans]: https://github.com/nanotech/jellybeans.vim
|
||
|
|
[solarized]: http://ethanschoonover.com/solarized
|
||
|
|
|
||
|
|
Attention
|
||
|
|
---------
|
||
|
|
|
||
|
|
1. [Read this first](https://github.com/morhetz/gruvbox/wiki/Terminal-specific)
|
||
|
|
2. Typeface from gallery is [Fantasque Sans Mono](https://github.com/belluzj/fantasque-sans)
|
||
|
|
3. Typeface from screenshots below is [Fira Mono](http://www.carrois.com/fira-4-1/)
|
||
|
|
|
||
|
|
Screenshots
|
||
|
|
-----------
|
||
|
|
|
||
|
|
Refer [Gallery][] for more syntax-specific screenshots.
|
||
|
|
|
||
|
|
[Gallery]: https://github.com/morhetz/gruvbox/wiki/Gallery
|
||
|
|
|
||
|
|
### Dark mode
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Light mode
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Airline theme
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Palette
|
||
|
|
-------
|
||
|
|
|
||
|
|
### Dark mode
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Light mode
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Contrast options
|
||
|
|
----------------
|
||
|
|
|
||
|
|
Refer [wiki section][] for contrast configuration and other options.
|
||
|
|
|
||
|
|
[wiki section]: https://github.com/morhetz/gruvbox/wiki/Configuration#ggruvbox_contrast_dark
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Documentation
|
||
|
|
-------------
|
||
|
|
|
||
|
|
Please check [wiki][] for installation details, terminal-specific setup, troubleshooting, configuration options and others.
|
||
|
|
|
||
|
|
[wiki]: https://github.com/morhetz/gruvbox/wiki
|
||
|
|
|
||
|
|
Features
|
||
|
|
--------
|
||
|
|
|
||
|
|
* Lots of style-customization options (contrast, color invertion, italics usage etc.)
|
||
|
|
* Extended filetype highlighting: Html, Xml, Vim (and ES6 with [yajs.vim](https://github.com/othree/yajs.vim)), Clojure, C, Python, JavaScript, CoffeeScript, Ruby, Objective-C, Go, Lua, MoonScript, Java, Markdown, Haskell
|
||
|
|
* Supported plugins: [EasyMotion][], [vim-sneak][], [Indent Guides][], [indentLine][], [Rainbow Parentheses][], [Airline][], [Lightline][], [GitGutter][], [Signify][], [ShowMarks][], [Signature][], [Syntastic][], [CtrlP][], [Startify][]
|
||
|
|
|
||
|
|
[EasyMotion]: https://github.com/Lokaltog/vim-easymotion
|
||
|
|
[vim-sneak]: https://github.com/justinmk/vim-sneak
|
||
|
|
[Indent Guides]: https://github.com/nathanaelkane/vim-indent-guides
|
||
|
|
[indentLine]: https://github.com/Yggdroot/indentLine
|
||
|
|
[Rainbow Parentheses]: https://github.com/kien/rainbow_parentheses.vim
|
||
|
|
[Airline]: https://github.com/bling/vim-airline
|
||
|
|
[Lightline]: https://github.com/itchyny/lightline.vim
|
||
|
|
[GitGutter]: https://github.com/airblade/vim-gitgutter
|
||
|
|
[Signify]: https://github.com/mhinz/vim-signify
|
||
|
|
[ShowMarks]: http://www.vim.org/scripts/script.php?script_id=152
|
||
|
|
[Signature]: https://github.com/kshenoy/vim-signature
|
||
|
|
[Syntastic]: https://github.com/scrooloose/syntastic
|
||
|
|
[CtrlP]: https://github.com/kien/ctrlp.vim
|
||
|
|
[Startify]: https://github.com/mhinz/vim-startify
|
||
|
|
|
||
|
|
Contributions
|
||
|
|
-------------
|
||
|
|
|
||
|
|
See [gruvbox-contrib][] repo for contributions, ports and extras.
|
||
|
|
|
||
|
|
[gruvbox-contrib]: https://github.com/morhetz/gruvbox-contrib
|
||
|
|
|
||
|
|
ToDo
|
||
|
|
----
|
||
|
|
|
||
|
|
* Filetype syntax highlighting (R, TeX, Swift, Erlang, Purescript and I'm still dissatisfied with CSS)
|
||
|
|
* Plugin support (MiniBufExplorer, Tagbar, Netrw, VimPLug)
|
||
|
|
|
||
|
|
Self-Promotion
|
||
|
|
--------------
|
||
|
|
|
||
|
|
If you like gruvbox follow the repository on
|
||
|
|
[GitHub](https://github.com/morhetz/gruvbox) and vote for it on
|
||
|
|
[vim.org](http://www.vim.org/scripts/script.php?script_id=4349).
|
||
|
|
|
||
|
|
License
|
||
|
|
-------
|
||
|
|
[MIT/X11][]
|
||
|
|
|
||
|
|
[MIT/X11]: https://en.wikipedia.org/wiki/MIT_License
|