mirror of
https://github.com/timmypidashev/darkbox.nvim.git
synced 2026-04-14 03:33:51 +00:00
Rename vivid contrast to dim(its very dim); Update README.md
This commit is contained in:
60
README.md
60
README.md
@@ -9,6 +9,17 @@ A pure-black refresh of the retro-groove aesthetic for modern displays. Darkbox
|
||||
- Retro-groove inspired color palette with modern refinements
|
||||
- Built-in support for tree-sitter
|
||||
|
||||
## 📸 Screenshots
|
||||
|
||||
### Base
|
||||

|
||||
|
||||
### Classic
|
||||

|
||||
|
||||
### Dim
|
||||

|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
|
||||
@@ -25,9 +36,54 @@ return {
|
||||
}
|
||||
```
|
||||
|
||||
## 📸 Screenshot
|
||||
## ✏️ Configuration
|
||||
|
||||

|
||||
Additional settings for darkbox are available:
|
||||
```lua
|
||||
-- Default options:
|
||||
require("darkbox").setup({
|
||||
terminal_colors = true, -- add neovim terminal colors
|
||||
undercurl = true,
|
||||
underline = true,
|
||||
bold = true,
|
||||
italic = {
|
||||
strings = true,
|
||||
emphasis = true,
|
||||
comments = true,
|
||||
operators = false,
|
||||
folds = true,
|
||||
},
|
||||
strikethrough = true,
|
||||
invert_selection = false,
|
||||
invert_signs = false,
|
||||
invert_tabline = false,
|
||||
invert_intend_guides = false,
|
||||
inverse = true, -- invert background for search, diffs, statuslines and errors
|
||||
contrast = "", -- can be "classic", "dim" or empty string
|
||||
palette_overrides = {},
|
||||
overrides = {},
|
||||
dim_inactive = false,
|
||||
transparent_mode = false,
|
||||
})
|
||||
vim.cmd("colorscheme darkbox")
|
||||
```
|
||||
|
||||
**VERY IMPORTANT**: Make sure to call setup() **BEFORE** calling the colorscheme command, to use your custom configs
|
||||
|
||||
## 🔧 Overrides
|
||||
|
||||
### Palette
|
||||
|
||||
You can specify your own palette colors. For example:
|
||||
|
||||
```lua
|
||||
require("darkbox").setup({
|
||||
palette_overrides = {
|
||||
base_red = "#991900",
|
||||
}
|
||||
})
|
||||
vim.cmd("colorscheme darkbox")
|
||||
```
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user