mirror of
https://github.com/morhetz/gruvbox.git
synced 2025-11-17 07:43:38 -05:00
Support for Signify, ShowMarks and vim-signature; docs updating
This commit is contained in:
morhetz
58
README.md
58
README.md
@@ -3,19 +3,17 @@ gruvbox
|
||||
|
||||
Retro groove color scheme for Vim.
|
||||
|
||||
Gruvbox is heavily inspired by [badwolf][1], [jellybeans][2] and [solarized][3].
|
||||
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][3]. The main focus when developing Gruvbox is to keep colors easily distinguishable, contrast enough and still pleasant for the eyes.
|
||||
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.
|
||||
|
||||
[1]: https://github.com/sjl/badwolf
|
||||
[2]: https://github.com/nanotech/jellybeans.vim
|
||||
[3]: http://ethanschoonover.com/solarized
|
||||
[badwolf]: https://github.com/sjl/badwolf
|
||||
[jellybeans]: https://github.com/nanotech/jellybeans.vim
|
||||
[solarized]: http://ethanschoonover.com/solarized
|
||||
|
||||
Screenshots
|
||||
-----------
|
||||
|
||||
Color scheme is in early development stage, so this could serve as working preview.
|
||||
|
||||
### Dark mode
|
||||
|
||||
|
||||
@@ -27,17 +25,18 @@ Color scheme is in early development stage, so this could serve as working previ
|
||||
Features
|
||||
--------
|
||||
|
||||
* Distraction-free HTML highlighting
|
||||
* Clojure detailed support
|
||||
* [Airline][4] theme mapping
|
||||
* Hand-tuned plugin-specific highlighting for [EasyMotion][5], [Better Rainbow Parentheses][6], [Indent Guides][7], [Syntastic][8] and [Git Gutter][9]
|
||||
* Extended filetype highlighting: Html, Vim, Clojure
|
||||
* Supported plugins: [EasyMotion][4], [Indent Guides][5], [Rainbow Parentheses][6], [Airline][7], [GitGutter][8], [Signify][9], [ShowMarks][10], [Signature][11], [Syntastic][12]
|
||||
|
||||
[4]: https://github.com/bling/vim-airline
|
||||
[5]: https://github.com/Lokaltog/vim-easymotion
|
||||
[6]: https://github.com/kien/rainbow_parentheses.vim
|
||||
[7]: https://github.com/nathanaelkane/vim-indent-guides
|
||||
[8]: https://github.com/scrooloose/syntastic
|
||||
[9]: https://github.com/airblade/vim-gitgutter
|
||||
[EasyMotion]: https://github.com/Lokaltog/vim-easymotion
|
||||
[Indent Guides]: https://github.com/nathanaelkane/vim-indent-guides
|
||||
[Rainbow Parentheses]: https://github.com/kien/rainbow_parentheses.vim
|
||||
[Airline]: https://github.com/bling/vim-airline
|
||||
[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
|
||||
|
||||
Usage
|
||||
-----
|
||||
@@ -60,7 +59,7 @@ Just setting background to an appropriate value would work as well:
|
||||
set bg=dark " Setting dark mode
|
||||
set bg=light " Setting light mode
|
||||
|
||||
Since gruvbox inverts cursor color, it could be awkward to determine current position, when the search is highlighted. To get single cursor color while searching map these gruvbox functions same way:
|
||||
Since gruvbox inverts cursor color, it could be awkward to determine current position, when the search is highlighted. To get single cursor color while searching, map these gruvbox functions same way:
|
||||
|
||||
map <silent> <F4> :call gruvbox#hls_toggle()<CR>
|
||||
imap <silent> <F4> <ESC>:call gruvbox#hls_toggle()<CR>a
|
||||
@@ -74,8 +73,6 @@ Since gruvbox inverts cursor color, it could be awkward to determine current pos
|
||||
|
||||
So you'll get `g:gruvbox_hls_cursor` (orange by default) cursor color when highlight search is on and inverted one otherwise. With such mappings you could also toggle search highlight on and off with F4 and hide it with Enter.
|
||||
|
||||
[10]: https://gist.github.com/morhetz/6795169
|
||||
|
||||
Terminal-specific
|
||||
-----------------
|
||||
|
||||
@@ -93,16 +90,16 @@ Most terminals doesn't allow italics so the text that must be italicized goes in
|
||||
|
||||
### Effect of gruvbox_256palette.sh gets reset on Alt-Tab
|
||||
|
||||
That's known issue with Ubuntu GTK-themes. Refer [†][10] for more details. Known affected terms are Gnome Terminal, Terminator and Lilyterm and probably more VTE-based. Though with Lilyterm option 'Dim text when inactive' set off everything works fine.
|
||||
That's known issue with Ubuntu GTK-themes. Refer [†][1] for more details. Known affected terms are Gnome Terminal, Terminator and Lilyterm and probably more VTE-based. Though with Lilyterm option 'Dim text when inactive' set off everything works fine.
|
||||
|
||||
[11]: https://github.com/morhetz/gruvbox/issues/13#issuecomment-30063099
|
||||
[1]: https://github.com/morhetz/gruvbox/issues/13#issuecomment-30063099
|
||||
|
||||
### Lighter colors with iTerm2
|
||||
|
||||
(...). Refer [†][11] and [‡][12] for more details.
|
||||
(...). Refer [†][2] and [‡][3] for more details.
|
||||
|
||||
[12]: https://github.com/morhetz/gruvbox/issues/8#issuecomment-26782758
|
||||
[13]: https://github.com/morhetz/gruvbox/issues/8#issuecomment-27627656
|
||||
[2]: https://github.com/morhetz/gruvbox/issues/8#issuecomment-26782758
|
||||
[3]: https://github.com/morhetz/gruvbox/issues/8#issuecomment-27627656
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
@@ -124,10 +121,10 @@ Enables undercurled text.
|
||||
default: `1`
|
||||
|
||||
### g:gruvbox_termcolors
|
||||
Uses 256-color palette (suitable to pair with gruvbox-palette shell script). If you're dissatisfied with that, set option value to `16` to fallback base colors to your terminal palette. Refer [†][14] for details.
|
||||
Uses 256-color palette (suitable to pair with gruvbox-palette shell script). If you're dissatisfied with that, set option value to `16` to fallback base colors to your terminal palette. Refer [†][4] for details.
|
||||
default: `256`
|
||||
|
||||
[14]: https://github.com/morhetz/gruvbox/issues/4
|
||||
[4]: https://github.com/morhetz/gruvbox/issues/4
|
||||
|
||||
### g:gruvbox_hls_cursor
|
||||
Changes cursor background while search is highlighted. Possible values are any of gruvbox palette.
|
||||
@@ -160,14 +157,15 @@ default: `0`
|
||||
Contributions
|
||||
-------------
|
||||
|
||||
See [gruvbox-generalized][15] repo for contributions, ports and extras.
|
||||
See [gruvbox-generalized][] repo for contributions, ports and extras.
|
||||
|
||||
[15]: https://github.com/morhetz/gruvbox-generalized
|
||||
[gruvbox-generalized]: https://github.com/morhetz/gruvbox-generalized
|
||||
|
||||
ToDo
|
||||
----
|
||||
|
||||
* More fyletype specific highlighting (ruby, python, javascript, coffeescript)
|
||||
* More fyletype specific highlighting (ruby, python, javascript)
|
||||
* Plugin support (Ctrl-P, MiniBufExplorer, Startify, Tagbar)
|
||||
* Airline theme
|
||||
|
||||
License
|
||||
|
||||
Reference in New Issue
Block a user