timmypidashev/darkbox.nvim
1
0
Fork 0
mirror of https://github.com/timmypidashev/darkbox.nvim.git synced 2026-06-03 14:24:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add vim.pack config for Neovim 0.12

Browse Source
This commit is contained in:
Timothy Pidashev
2026-04-15 10:50:33 -07:00
parent 40960993dc
commit 999748927d
1 changed files with 43 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+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