mirror of
https://github.com/timmypidashev/darkbox.nvim.git
synced 2026-06-03 14:24:37 +00:00
Compare commits
3 Commits
40960993dc
...
c9851bc173
| Author | SHA1 | Date | |
|---|---|---|---|
|
c9851bc173
|
|||
| d69165b433 | |||
|
999748927d
|
@@ -22,25 +22,48 @@ A pure-black refresh of the retro-groove aesthetic for modern displays. Darkbox
|
||||
|
||||
## 🚀 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
|
||||
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
|
||||
|
||||
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,
|
||||
@@ -65,24 +88,28 @@ require("darkbox").setup({
|
||||
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
|
||||
|
||||
### 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")
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
+45
-16
@@ -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")
|
||||
<
|
||||
|
||||
|
||||
|
||||
+4
-4
@@ -260,7 +260,7 @@ local function get_groups()
|
||||
Question = { link = "DarkboxOrangeBold" },
|
||||
WarningMsg = { link = "DarkboxRedBold" },
|
||||
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 },
|
||||
FoldColumn = config.transparent_mode and { fg = colors.gray, bg = nil }
|
||||
or { fg = colors.gray, bg = colors.background_1 },
|
||||
@@ -340,9 +340,9 @@ local function get_groups()
|
||||
LspSignatureActiveParameter = { link = "Search" },
|
||||
gitcommitSelectedFile = { link = "DarkboxGreen" },
|
||||
gitcommitDiscardedFile = { link = "DarkboxRed" },
|
||||
GitSignsAdd = { link = "DarkboxGreen" },
|
||||
GitSignsChange = { link = "DarkboxOrange" },
|
||||
GitSignsDelete = { link = "DarkboxRed" },
|
||||
GitSignsAdd = { fg = colors.green },
|
||||
GitSignsChange = { fg = colors.orange },
|
||||
GitSignsDelete = { fg = colors.red },
|
||||
NvimTreeSymlink = { fg = colors.neutral_aqua },
|
||||
NvimTreeRootFolder = { fg = colors.neutral_purple, bold = true },
|
||||
NvimTreeFolderIcon = { fg = colors.neutral_blue, bold = true },
|
||||
|
||||
Reference in New Issue
Block a user