auto-generate vimdoc

1 files changed, 143 insertions, 0 deletions

diff --git a/doc/gruvbox.nvim.txt b/doc/gruvbox.nvim.txt
index e69de29..3350b54 100644
--- a/doc/gruvbox.nvim.txt
+++ b/doc/gruvbox.nvim.txt
@@ -0,0 +1,143 @@
+*gruvbox.nvim.txt*      For Neovim >= 0.8.0     Last change: 2023 September 24
+
+==============================================================================
+Table of Contents                             *gruvbox.nvim-table-of-contents*
+
+1. Prerequisites                                  |gruvbox.nvim-prerequisites|
+2. Installing                                        |gruvbox.nvim-installing|
+3. Basic Usage                                      |gruvbox.nvim-basic-usage|
+4. Configuration                                  |gruvbox.nvim-configuration|
+  - Overriding                         |gruvbox.nvim-configuration-overriding|
+>
+      <h1> <img src="https://i.postimg.cc/WpQzgxVh/plugin-Icon.png" width="80px"><br/>gruvbox.nvim</h1>
+     </div>
+<
+
+
+A port of gruvbox community <https://github.com/gruvbox-community/gruvbox>
+theme to lua with treesitter
+<https://github.com/nvim-treesitter/nvim-treesitter> support!
+
+
+==============================================================================
+1. Prerequisites                                  *gruvbox.nvim-prerequisites*
+
+Neovim 0.8.0+
+
+
+==============================================================================
+2. Installing                                        *gruvbox.nvim-installing*
+
+Using `packer`
+
+>lua
+    use { "ellisonleao/gruvbox.nvim" }
+<
+
+Using `lazy.nvim`
+
+>lua
+    { "ellisonleao/gruvbox.nvim", priority = 1000 }
+<
+
+
+==============================================================================
+3. Basic Usage                                      *gruvbox.nvim-basic-usage*
+
+Inside `init.vim`
+
+>vim
+    set background=dark " or light if you want light mode
+    colorscheme gruvbox
+<
+
+Inside `init.lua`
+
+>lua
+    vim.o.background = "dark" -- or "light" for light mode
+    vim.cmd([[colorscheme gruvbox]])
+<
+
+
+==============================================================================
+4. Configuration                                  *gruvbox.nvim-configuration*
+
+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
+      undercurl = true,
+      underline = true,
+      bold = true,
+      italic = {
+        strings = true,
+        emphasis = true,
+        comments = true,
+        operators = false,
+        folds = true,
+      },
+      strikethrough = true,
+      invert_selection = false,
+      invert_signs = false,
+      invert_tabline = false,
+      invert_intend_guides = false,
+      inverse = true, -- invert background for search, diffs, statuslines and errors
+      contrast = "", -- can be "hard", "soft" or empty string
+      palette_overrides = {},
+      overrides = {},
+      dim_inactive = false,
+      transparent_mode = false,
+    })
+    vim.cmd("colorscheme gruvbox")
+<
+
+
+OVERRIDING                             *gruvbox.nvim-configuration-overriding*
+
+
+PALETTE ~
+
+You can specify your own palette colors. For example:
+
+>lua
+    require("gruvbox").setup({
+        palette_overrides = {
+            bright_green = "#990000",
+        }
+    })
+    vim.cmd("colorscheme gruvbox")
+<
+
+More colors in the palette.lua <lua/gruvbox/palette.lua> file
+
+
+HIGHLIGHT GROUPS ~
+
+If you don’t enjoy the current color for a specific highlight group, now you
+can just override it in the setup. For example:
+
+>lua
+    require("gruvbox").setup({
+        overrides = {
+            SignColumn = {bg = "#ff9900"}
+        }
+    })
+    vim.cmd("colorscheme gruvbox")
+<
+
+Please note that the override values must follow the attributes from the
+highlight group map, such as:
+
+- **fg** - foreground color
+- **bg** - background color
+- **bold** - true or false for bold font
+- **italic** - true or false for italic font
+
+Other values can be seen in |synIDattr|
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl: