mirror of
https://github.com/timmypidashev/darkbox.nvim.git
synced 2026-06-03 14:24:37 +00:00
auto-generate vimdoc
This commit is contained in:
+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*
|
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")
|
||||||
<
|
<
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user