Merge branch 'main' of https://github.com/timmypidashev/darkbox

2026-04-14 03:33:51 +00:00 · 2025-02-03 14:13:08 -08:00
parent d27760d7b3 318f28e3f1
commit 44d740219b
1 changed files with 142 additions and 0 deletions
--- a/doc/darkbox.nvim.txt
+++ b/doc/darkbox.nvim.txt
@@ -0,0 +1,142 @@
+*darkbox.nvim.txt*      For Neovim >= 0.8.0      Last change: 2025 February 03
+
+==============================================================================
+Table of Contents                             *darkbox.nvim-table-of-contents*
+
+  - Features                                           |darkbox.nvim-features|
+  - Screenshots                                     |darkbox.nvim-screenshots|
+  - Installation                                   |darkbox.nvim-installation|
+  - Configuration                                 |darkbox.nvim-configuration|
+  - Overrides                                         |darkbox.nvim-overrides|
+  - Contributing                                   |darkbox.nvim-contributing|
+  - License                                             |darkbox.nvim-license|
+1. Links                                                  |darkbox.nvim-links|
+# Darkbox.nvim
+
+A pure-black refresh of the retro-groove aesthetic for modern displays. Darkbox
+brings the classic groove style into the modern era with a focus on
+OLED-friendly pure blacks and carefully selected contrasts.
+
+
+FEATURES                                               *darkbox.nvim-features*
+
+- Pure black (#000000) background optimized for OLED displays
+- Retro-groove inspired color palette with modern refinements
+- Built-in support for tree-sitter
+
+
+SCREENSHOTS                                         *darkbox.nvim-screenshots*
+
+
+CLASSIC ~
+
+
+RETRO ~
+
+
+DIM ~
+
+
+INSTALLATION                                       *darkbox.nvim-installation*
+
+
+USING LAZY.NVIM ~
+
+Add the following to your Neovim configuration:
+
+>lua
+    return {
+      "timmypidashev/darkbox.nvim",
+      lazy = false,
+      config = function()
+        require("darkbox").load()
+      end
+    }
+<
+
+
+CONFIGURATION                                     *darkbox.nvim-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 "retro", "dim" or empty string for classic
+      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                                             *darkbox.nvim-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                                       *darkbox.nvim-contributing*
+
+Contributions are welcome! Feel free to:
+
+1. Report issues
+2. Suggest improvements
+3. Create pull requests
+4. Share your configurations
+
+
+LICENSE                                                 *darkbox.nvim-license*
+
+MIT License - See LICENSE <LICENSE> for details
+
+------------------------------------------------------------------------------
+View the project page <https://timmypidashev.dev/projects/darkbox> for darkbox
+on my website for more info :D
+
+Made with by timmypidashev <https://github.com/timmypidashev>
+
+==============================================================================
+1. Links                                                  *darkbox.nvim-links*
+
+1. *Darkbox Theme Preview*: .github/darkbox.png
+2. *Screenshot*: .github/screenshot_classic.png
+3. *Screenshot*: .github/screenshot_retro.png
+4. *Screenshot*: .github/screenshot_dim.png
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl: