You can now run `nix build '.#docs'` to build HTML documentation documenting every single option on nixvim! Fortunately, thanks to the 'description' field, most options are already documented, but there are still a fair few that need documenting. I will be taking care of those in the next few days. When those are done, I will find a way to automatically rebuild documentation on every repo push, and also add a PR hook requiring documentation. Additionally, I will try to find a way to have per-page plugin docs.
2.7 KiB
gruvbox
This plugin sets up the gruvbox colorscheme.
Options
colorschemes.gruvbox.enable
Description: Enable gruvbox
Type: bool
colorschemes.gruvbox.italics
Description: Enable italics
Type: bool
colorschemes.gruvbox.bold
Description: Enable bold
Type: bool
colorschemes.gruvbox.underline
Description: Enable underlined text
Type: bool
colorschemes.gruvbox.undercurl
Description: Enable undercurled text
Type: bool
colorschemes.gruvbox.contrastDark
Description: Contrast for the dark mode
Type: nullOr (enum [ "soft" "medium" "hard" ])
Default: null
colorschemes.gruvbox.contrastLight
Type: nullOr (enum [ "soft" "medium" "hard" ])
Default: null
Description: "Contrast for the light mode";
colorschemes.gruvbox.highlightSearchCursor
Type: nullOr colors
Default: null
Description: "The cursor background while search is highlighted";
colorschemes.gruvbox.numberColumn
Description: The number column background
Type: nullOr colors
Default: null
colorschemes.gruvbox.signColumn
Description: "The sign column background";
Type: nullOr colors
Default: null
colorschemes.gruvbox.colorColumn
Description: "The color column background";
Type: nullOr colors
Default: null
colorschemes.gruvbox.vertSplitColor
Description: "The vertical split background color";
Type: nullOr colors
Default: null
colorschemes.gruvbox.italicizeComments
Description: "Italicize comments";
Type: bool
Default: true
colorschemes.gruvbox.italicizeStrings
Description: "Italicize strings";
Type: bool
Default: false
colorschemes.gruvbox.invertSelection
Description: "Invert the select text";
Type: bool
Default: true
colorschemes.gruvbox.invertSigns
Description: "Invert GitGutter and Syntastic signs";
Type: bool
Default: false
colorschemes.gruvbox.invertIndentGuides
Description: "Invert indent guides";
Type: bool
Default: false
colorschemes.gruvbox.invertTabline
Description: "Invert tabline highlights";
Type: bool
Default: false
colorschemes.gruvbox.improvedStrings
Description: "Improved strings";
Type: bool
Default: false
colorschemes.gruvbox.improvedWarnings
Description: "Improved warnings";
Type: bool
Default: false
colorschemes.gruvbox.transparentBg
Description: Transparent background
Type: bool
colorschemes.gruvbox.trueColor
Description: Enable true color support
Type: bool