From 61b0b3be2f0cfd521667403a0367298144d6c165 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 30 Sep 2023 22:35:20 +0000 Subject: auto-generate vimdoc --- doc/gruvbox.nvim.txt | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/doc/gruvbox.nvim.txt b/doc/gruvbox.nvim.txt index 52d5b0c..d7b1abf 100644 --- a/doc/gruvbox.nvim.txt +++ b/doc/gruvbox.nvim.txt @@ -1,10 +1,12 @@ -*gruvbox.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 September 28 +*gruvbox.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 September 30 ============================================================================== Table of Contents *gruvbox.nvim-table-of-contents* 1. Prerequisites |gruvbox.nvim-prerequisites| 2. Installing |gruvbox.nvim-installing| + - Using packer |gruvbox.nvim-installing-using-packer| + - Using lazy.nvim |gruvbox.nvim-installing-using-lazy.nvim| 3. Basic Usage |gruvbox.nvim-basic-usage| 4. Configuration |gruvbox.nvim-configuration| - Overriding |gruvbox.nvim-configuration-overriding| @@ -16,7 +18,8 @@ Table of Contents *gruvbox.nvim-table-of-contents* A port of gruvbox community theme to lua with treesitter - support! + and |semantic highlights| +support! ============================================================================== @@ -28,16 +31,18 @@ Neovim 0.8.0+ ============================================================================== 2. Installing *gruvbox.nvim-installing* -Using `packer` + +USING PACKER *gruvbox.nvim-installing-using-packer* >lua use { "ellisonleao/gruvbox.nvim" } < -Using `lazy.nvim` + +USING LAZY.NVIM *gruvbox.nvim-installing-using-lazy.nvim* >lua - { "ellisonleao/gruvbox.nvim", priority = 1000 } + { "ellisonleao/gruvbox.nvim", priority = 1000 , setup = true, opts = ...} < @@ -65,7 +70,6 @@ Inside `init.lua` Additional settings for gruvbox are: >lua - -- setup must be called before loading the colorscheme -- Default options: require("gruvbox").setup({ terminal_colors = true, -- add neovim terminal colors @@ -94,6 +98,9 @@ Additional settings for gruvbox are: vim.cmd("colorscheme gruvbox") < +**VERY IMPORTANT**Make sure to call setup() **BEFORE** calling the colorscheme +command, to use your custom configs + OVERRIDING *gruvbox.nvim-configuration-overriding* @@ -111,8 +118,6 @@ You can specify your own palette colors. For example: vim.cmd("colorscheme gruvbox") < -More colors in the palette.lua file - HIGHLIGHT GROUPS ~ @@ -128,6 +133,18 @@ can just override it in the setup. For example: vim.cmd("colorscheme gruvbox") < +It also works with treesitter groups and lsp semantic highlight tokens + +>lua + require("gruvbox").setup({ + overrides = { + ["@lsp.type.method"] = { bg = "#ff9900" }, + ["@comment.lua"] = { bg = "#000000" }, + } + }) + vim.cmd("colorscheme gruvbox") +< + Please note that the override values must follow the attributes from the highlight group map, such as: @@ -136,7 +153,7 @@ highlight group map, such as: - **bold** - true or false for bold font - **italic** - true or false for italic font -Other values can be seen in |synIDattr| +Other values can be seen in |`synIDattr`| Generated by panvimdoc -- cgit v1.2.3