Compare commits

...

3 Commits

Author SHA1 Message Date
timmypidashev c9851bc173 fix: flatten SignColumn and GitSigns backgrounds to match Normal 2026-04-15 11:16:38 -07:00
github-actions[bot] d69165b433 auto-generate vimdoc 2026-04-15 17:50:59 +00:00
timmypidashev 999748927d Add vim.pack config for Neovim 0.12 2026-04-15 10:50:33 -07:00
3 changed files with 92 additions and 36 deletions
+43 -16
View File
@@ -22,25 +22,48 @@ A pure-black refresh of the retro-groove aesthetic for modern displays. Darkbox
## 🚀 Installation ## 🚀 Installation
### Using [lazy.nvim](https://github.com/folke/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](https://github.com/folke/lazy.nvim)
```lua ```lua
return { return {
"timmypidashev/darkbox.nvim", "timmypidashev/darkbox.nvim",
lazy = false, lazy = false,
priority = 1000,
config = function() config = function()
require("darkbox").load() require("darkbox").setup({
end 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 ## ✏️ Configuration
Additional settings for darkbox are available: All available options with their defaults:
```lua ```lua
-- Default options: vim.pack.add({
{ src = "https://github.com/timmypidashev/darkbox.nvim" },
})
require("darkbox").setup({ require("darkbox").setup({
terminal_colors = true, -- add neovim terminal colors terminal_colors = true, -- add neovim terminal colors
undercurl = true, undercurl = true,
@@ -65,24 +88,28 @@ require("darkbox").setup({
dim_inactive = false, dim_inactive = false,
transparent_mode = 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 ## 🔧 Overrides
### Palette ### Palette
You can specify your own palette colors. For example: Specify your own palette colors:
```lua ```lua
require("darkbox").setup({ vim.pack.add({
palette_overrides = { { src = "https://github.com/timmypidashev/darkbox.nvim" },
base_red = "#991900",
}
}) })
vim.cmd("colorscheme darkbox")
require("darkbox").setup({
palette_overrides = {
base_red = "#991900",
},
})
vim.cmd.colorscheme("darkbox")
``` ```
## 🤝 Contributing ## 🤝 Contributing
+45 -16
View File
@@ -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* Table of Contents *darkbox.nvim-table-of-contents*
@@ -40,27 +41,51 @@ DIM ~
INSTALLATION *darkbox.nvim-installation* 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 >lua
return { return {
"timmypidashev/darkbox.nvim", "timmypidashev/darkbox.nvim",
lazy = false, lazy = false,
priority = 1000,
config = function() config = function()
require("darkbox").load() require("darkbox").setup({
end 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* CONFIGURATION *darkbox.nvim-configuration*
Additional settings for darkbox are available: All available options with their defaults:
>lua >lua
-- Default options: vim.pack.add({
{ src = "https://github.com/timmypidashev/darkbox.nvim" },
})
require("darkbox").setup({ require("darkbox").setup({
terminal_colors = true, -- add neovim terminal colors terminal_colors = true, -- add neovim terminal colors
undercurl = true, undercurl = true,
@@ -85,11 +110,11 @@ Additional settings for darkbox are available:
dim_inactive = false, dim_inactive = false,
transparent_mode = false, transparent_mode = false,
}) })
vim.cmd("colorscheme darkbox") vim.cmd.colorscheme("darkbox")
< <
**VERY IMPORTANT**Make sure to call setup() **BEFORE** calling the colorscheme **VERY IMPORTANT**: Call `setup()` **BEFORE** the colorscheme command to apply
command, to use your custom configs custom configs.
OVERRIDES *darkbox.nvim-overrides* OVERRIDES *darkbox.nvim-overrides*
@@ -97,15 +122,19 @@ OVERRIDES *darkbox.nvim-overrides*
PALETTE ~ PALETTE ~
You can specify your own palette colors. For example: Specify your own palette colors:
>lua >lua
require("darkbox").setup({ vim.pack.add({
palette_overrides = { { src = "https://github.com/timmypidashev/darkbox.nvim" },
base_red = "#991900",
}
}) })
vim.cmd("colorscheme darkbox")
require("darkbox").setup({
palette_overrides = {
base_red = "#991900",
},
})
vim.cmd.colorscheme("darkbox")
< <
+4 -4
View File
@@ -260,7 +260,7 @@ local function get_groups()
Question = { link = "DarkboxOrangeBold" }, Question = { link = "DarkboxOrangeBold" },
WarningMsg = { link = "DarkboxRedBold" }, WarningMsg = { link = "DarkboxRedBold" },
LineNr = { fg = colors.background_4 }, LineNr = { fg = colors.background_4 },
SignColumn = config.transparent_mode and { bg = nil } or { bg = colors.background_1 }, SignColumn = { bg = nil },
Folded = { fg = colors.gray, bg = colors.background_1, italic = config.italic.folds }, Folded = { fg = colors.gray, bg = colors.background_1, italic = config.italic.folds },
FoldColumn = config.transparent_mode and { fg = colors.gray, bg = nil } FoldColumn = config.transparent_mode and { fg = colors.gray, bg = nil }
or { fg = colors.gray, bg = colors.background_1 }, or { fg = colors.gray, bg = colors.background_1 },
@@ -340,9 +340,9 @@ local function get_groups()
LspSignatureActiveParameter = { link = "Search" }, LspSignatureActiveParameter = { link = "Search" },
gitcommitSelectedFile = { link = "DarkboxGreen" }, gitcommitSelectedFile = { link = "DarkboxGreen" },
gitcommitDiscardedFile = { link = "DarkboxRed" }, gitcommitDiscardedFile = { link = "DarkboxRed" },
GitSignsAdd = { link = "DarkboxGreen" }, GitSignsAdd = { fg = colors.green },
GitSignsChange = { link = "DarkboxOrange" }, GitSignsChange = { fg = colors.orange },
GitSignsDelete = { link = "DarkboxRed" }, GitSignsDelete = { fg = colors.red },
NvimTreeSymlink = { fg = colors.neutral_aqua }, NvimTreeSymlink = { fg = colors.neutral_aqua },
NvimTreeRootFolder = { fg = colors.neutral_purple, bold = true }, NvimTreeRootFolder = { fg = colors.neutral_purple, bold = true },
NvimTreeFolderIcon = { fg = colors.neutral_blue, bold = true }, NvimTreeFolderIcon = { fg = colors.neutral_blue, bold = true },