diff --git a/Configuration.md b/Configuration.md new file mode 100644 index 0000000..ca9470f --- /dev/null +++ b/Configuration.md @@ -0,0 +1,87 @@ +Options +------------- + +### g:gruvbox_bold +Enables bold text. +default: `1` + +### g:gruvbox_italic +Enables italic text. +default: `1` + +### g:gruvbox_underline +Enables underlined text. +default: `1` + +### g:gruvbox_undercurl +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 [†][4] for details. +default: `256` + +[4]: https://github.com/morhetz/gruvbox/issues/4 + +### g:gruvbox_contrast +Possible values are `soft`, `medium` and `hard`. +default: `medium` + +### g:gruvbox_hls_cursor +Changes cursor background while search is highlighted. Possible values are any of gruvbox palette. +default: `orange` + +### g:gruvbox_sign_column +Changes sign column background color. Possible values are any of gruvbox palette. +default: `dark1` + +### g:gruvbox_italicize_comments +Enables italic for comments. +default: `1` + +### g:gruvbox_italicize_strings +Enables italic for strings. +default: `0` + +### g:gruvbox_invert_selection +Inverts selected text. +default: `1` + +### g:gruvbox_invert_signs +Inverts GitGutter and Syntastic signs. Useful to rapidly focus on. +default: `0` + +### g:gruvbox_invert_indent_guides +Inverts indent guides. Could be nice paired with `set list` so it would highlight only tab symbols instead of it's background. +default: `0` + +Functions +--------- + +### gruvbox#bg_toggle() + +(...) + +### gruvbox#invert_signs_toggle() + +(...) + +### gruvbox#hls_show() + +(...) + +### gruvbox#hls_show_cursor() + +(...) + +### gruvbox#hls_hide() + +(...) + +### gruvbox#hls_hide_cursor() + +(...) + +### gruvbox#hls_toggle() + +(...) \ No newline at end of file