From d69165b433ba4f5b43b36011bf36ed7f1125deb8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 15 Apr 2026 17:50:59 +0000 Subject: [PATCH] auto-generate vimdoc --- doc/darkbox.nvim.txt | 61 ++++++++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 16 deletions(-) diff --git a/doc/darkbox.nvim.txt b/doc/darkbox.nvim.txt index 7faf128..bcaed6d 100644 --- a/doc/darkbox.nvim.txt +++ b/doc/darkbox.nvim.txt @@ -1,4 +1,5 @@ -*darkbox.nvim.txt* For Neovim >= 0.8.0 Last change: 2025 March 25 +*darkbox.nvim.txt* + For Neovim >= 0.8.0 Last change: 2026 April 15 ============================================================================== Table of Contents *darkbox.nvim-table-of-contents* @@ -40,27 +41,51 @@ DIM ~ INSTALLATION *darkbox.nvim-installation* -USING LAZY.NVIM ~ +USING VIM.PACK (NEOVIM 0.12+) ~ -Add the following to your Neovim configuration: +The built-in package manager. Recommended. + +>lua + vim.pack.add({ + { src = "https://github.com/timmypidashev/darkbox.nvim" }, + }) + + require("darkbox").setup({ + contrast = "retro", + }) + vim.cmd.colorscheme("darkbox") +< + + +USING LAZY.NVIM ~ >lua return { "timmypidashev/darkbox.nvim", lazy = false, + priority = 1000, config = function() - require("darkbox").load() - end + require("darkbox").setup({ + contrast = "retro", + }) + vim.cmd.colorscheme("darkbox") + end, } < + The examples below use the `vim.pack` pattern. If you use lazy.nvim, place the + `setup()` and `colorscheme` calls inside the `config` function instead. + CONFIGURATION *darkbox.nvim-configuration* -Additional settings for darkbox are available: +All available options with their defaults: >lua - -- Default options: + vim.pack.add({ + { src = "https://github.com/timmypidashev/darkbox.nvim" }, + }) + require("darkbox").setup({ terminal_colors = true, -- add neovim terminal colors undercurl = true, @@ -85,11 +110,11 @@ Additional settings for darkbox are available: dim_inactive = false, transparent_mode = false, }) - vim.cmd("colorscheme darkbox") + vim.cmd.colorscheme("darkbox") < -**VERY IMPORTANT**Make sure to call setup() **BEFORE** calling the colorscheme -command, to use your custom configs +**VERY IMPORTANT**: Call `setup()` **BEFORE** the colorscheme command to apply +custom configs. OVERRIDES *darkbox.nvim-overrides* @@ -97,15 +122,19 @@ OVERRIDES *darkbox.nvim-overrides* PALETTE ~ -You can specify your own palette colors. For example: +Specify your own palette colors: >lua - require("darkbox").setup({ - palette_overrides = { - base_red = "#991900", - } + vim.pack.add({ + { src = "https://github.com/timmypidashev/darkbox.nvim" }, }) - vim.cmd("colorscheme darkbox") + + require("darkbox").setup({ + palette_overrides = { + base_red = "#991900", + }, + }) + vim.cmd.colorscheme("darkbox") <