1- # ⚡ SilkCircuit: A Vibrant Neovim Theme
1+ # 💜 ⚡ SilkCircuit: Electric Dreams for Neovim 🌃
22
33<div align =" center " >
44
77[ ![ GitHub Stars] ( https://img.shields.io/github/stars/hyperb1iss/silkcircuit-nvim?style=for-the-badge&logo=github&logoColor=white&color=bd93f9 )] ( https://github.com/hyperb1iss/silkcircuit-nvim/stargazers )
88[ ![ CI] ( https://img.shields.io/github/actions/workflow/status/hyperb1iss/silkcircuit-nvim/ci.yml?branch=main&style=for-the-badge&logo=github-actions&logoColor=white&label=CI&color=50fa7b )] ( https://github.com/hyperb1iss/silkcircuit-nvim/actions/workflows/ci.yml )
99
10- _ A high-contrast theme featuring vibrant purples, electric pinks, and glowing accents_ ✨
10+ 🌌 _ Pure electric energy with vibrant purples, blazing pinks, and neon accents_ 🎆
1111
1212[ Installation] ( #-installation ) • [ Features] ( #-features ) • [ Configuration] ( #-configuration ) • [ Plugin Support] ( #-plugin-support )
1313
@@ -17,22 +17,23 @@ _A high-contrast theme featuring vibrant purples, electric pinks, and glowing ac
1717 <img src =" https://raw.githubusercontent.com/hyperb1iss/silkcircuit-nvim/main/assets/silkcircuit-preview.png " alt =" SilkCircuit Theme Preview " width =" 90% " >
1818</div >
1919
20- ## 🌟 Overview
20+ ## 🎭 Overview
2121
22- SilkCircuit is a carefully crafted Neovim colorscheme that combines vibrant colors with excellent readability. Featuring glowing purples, electric pinks, and bright cyans, it creates a visually striking coding environment while maintaining clarity and reducing eye strain .
22+ SilkCircuit pumps maximum visual voltage through your Neovim. Electric purples 💜, blazing pinks 🌸 , and neon cyans 💎 create a coding environment that's both striking and readable. Engineered for speed with <5ms load times and WCAG AA contrast compliance .
2323
24- ## ✨ Features
24+ ## 🦄 Features
2525
26- - 🎨 ** Vibrant Color Palette** - Eye-catching colors that make code elements distinct
27- - 🌲 ** Full Tree-sitter Support** - Advanced syntax highlighting with semantic tokens
28- - 🔌 ** 40+ Plugin Integrations** - Native support for all popular Neovim plugins
29- - 🚀 ** Zero Configuration** - Works out of the box with sensible defaults
30- - ⚙️ ** Highly Customizable** - Tweak any aspect to match your preferences
31- - 🖥️ ** Terminal Themes Included** - Matching themes for popular terminal emulators
26+ - 🎪 ** Electric Color System** — Vibrant palette with semantic color mappings
27+ - 🏎️ ** <5ms Load Time** — Bytecode compilation with intelligent caching
28+ - 👁️ ** WCAG AA Compliant** — Validated contrast ratios for extended coding sessions
29+ - 🎛️ ** Theme Variants** — Neon (100%), Vibrant (85%), and Soft (70%) intensity modes
30+ - 🔮 ** 40+ Plugin Integrations** — Auto-detected support for your entire toolchain
31+ - 🌟 ** Glow Mode** — Enhanced highlights for maximum visibility
32+ - 💾 ** Persistent Preferences** — Settings survive across sessions
3233
33- ## 📦 Installation
34+ ## 💫 Installation
3435
35- ### Using [ lazy.nvim] ( https://github.com/folke/lazy.nvim ) (Recommended)
36+ ### 🎯 Using [ lazy.nvim] ( https://github.com/folke/lazy.nvim ) (Recommended)
3637
3738``` lua
3839{
@@ -45,7 +46,7 @@ SilkCircuit is a carefully crafted Neovim colorscheme that combines vibrant colo
4546}
4647```
4748
48- ### Using [ packer.nvim] ( https://github.com/wbthomason/packer.nvim )
49+ ### 📦 Using [ packer.nvim] ( https://github.com/wbthomason/packer.nvim )
4950
5051``` lua
5152use {
@@ -56,14 +57,14 @@ use {
5657}
5758```
5859
59- ### Using [ vim-plug] ( https://github.com/junegunn/vim-plug )
60+ ### 🔮 Using [ vim-plug] ( https://github.com/junegunn/vim-plug )
6061
6162``` vim
6263Plug 'hyperb1iss/silkcircuit-nvim'
6364colorscheme silkcircuit
6465```
6566
66- ## 🚀 AstroNvim
67+ ## 🛸 AstroNvim
6768
6869SilkCircuit integrates seamlessly with AstroNvim, just like any community colorscheme:
6970
@@ -85,17 +86,17 @@ return {
8586
8687That's it! No additional configuration needed.
8788
88- ## ⚙️ Configuration
89+ ## 🎨 Configuration
8990
90- ### Default Setup
91-
92- SilkCircuit works great out of the box, but you can customize it:
91+ ### 🎪 Default Setup
9392
9493``` lua
9594require (" silkcircuit" ).setup ({
9695 transparent = false , -- Enable transparent background
9796 terminal_colors = true , -- Configure terminal colors
9897 dim_inactive = false , -- Dim inactive windows
98+ variant = " neon" , -- Theme variant: "neon" | "vibrant" | "soft"
99+ glow_mode = false , -- Enable glow mode
99100
100101 styles = {
101102 comments = { italic = true },
@@ -106,17 +107,48 @@ require("silkcircuit").setup({
106107 },
107108
108109 integrations = {
109- -- All integrations are enabled by default
110+ -- Auto-detected by default
110111 telescope = true ,
111112 neotree = true ,
112113 notify = true ,
113114 cmp = true ,
115+ mini = true ,
114116 -- See :h silkcircuit-integrations for full list
115117 },
116118})
117119```
118120
119- ### Transparent Background
121+ ### 🌈 Theme Variants
122+
123+ Switch between intensity levels:
124+
125+ ``` lua
126+ -- Via setup
127+ require (" silkcircuit" ).setup ({
128+ variant = " vibrant" , -- "neon" | "vibrant" | "soft"
129+ })
130+
131+ -- Or use commands
132+ :SilkCircuit neon -- 100% intensity
133+ :SilkCircuit vibrant -- 85% intensity
134+ :SilkCircuit soft -- 70% intensity
135+ ```
136+
137+ ### ✨ Glow Mode
138+
139+ Enhanced highlights for maximum visibility:
140+
141+ ``` lua
142+ -- Toggle glow mode
143+ :SilkCircuitGlow
144+
145+ -- Or in setup
146+ require (" silkcircuit" ).setup ({
147+ glow_mode = true ,
148+ })
149+ ```
150+
151+ ### 🌌 Transparent Background
120152
121153For a sleek, transparent look:
122154
@@ -126,7 +158,7 @@ require("silkcircuit").setup({
126158})
127159```
128160
129- ### Custom Highlights
161+ ### 🎯 Custom Highlights
130162
131163Override any highlight group:
132164
@@ -139,37 +171,51 @@ require("silkcircuit").setup({
139171})
140172```
141173
142- ## 🎯 Plugin Support
174+ ## 🌟 Plugin Support
175+
176+ SilkCircuit auto-detects and themes 40+ plugins:
143177
144- SilkCircuit includes thoughtfully designed integrations for 40+ plugins:
178+ ** 🎯 Core Functionality **
145179
146- ** Essential Plugins**
180+ - 🔭 Telescope → Fuzzy finder
181+ - 🌳 Neo-tree → File explorer
182+ - 💡 LSP → Language servers
183+ - 🌿 Treesitter → Syntax highlighting
184+ - 🎹 nvim-cmp → Completion
185+ - 📦 Mason → Package manager
147186
148- - 🔭 Telescope
149- - 🌳 Neo-tree / NvimTree
150- - 💡 LSP & Diagnostics
151- - 🔍 Treesitter
152- - ✨ nvim-cmp
187+ ** 🏃 Navigation & Motion**
153188
154- ** UI Enhancements**
189+ - ⚡ Flash / Leap → Jump motions
190+ - 🎣 Harpoon → File marks
191+ - 🗝️ Which-Key → Keybinding hints
192+ - 🦘 Mini.jump → Enhanced jumps
155193
156- - 💫 Lualine
157- - 📑 BufferLine
158- - 🔔 Notify
159- - 🎯 Which-Key
160- - 📊 Dashboard/Alpha
194+ ** 🔧 Git & Development**
161195
162- ** Development Tools**
196+ - 📊 Gitsigns → Git indicators
197+ - 🎭 Neogit → Git interface
198+ - 🐛 DAP → Debugging
199+ - 🧹 none-ls → Formatting/linting
163200
164- - 🔀 Gitsigns
165- - 🏃 Leap/Hop
166- - 🌈 Rainbow Delimiters
167- - 📝 Indent Blankline
168- - 🐛 DAP (Debugger)
201+ ** 💎 UI Components**
169202
170- And many more! All integrations work automatically when the plugins are installed.
203+ - 📍 Lualine → Status line
204+ - 📑 BufferLine → Buffer tabs
205+ - 🔔 Notify / Noice → Notifications
206+ - 🎪 Alpha → Dashboard
207+ - 📏 Mini.statusline → Minimal status
171208
172- ## 🎨 Terminal Support
209+ ** 🎨 Editor Enhancement**
210+
211+ - 🌈 Rainbow Delimiters → Bracket pairs
212+ - 📐 Indent Blankline → Indentation guides
213+ - 🔍 Mini.indentscope → Active indent
214+ - 💫 Mini.cursorword → Word highlighting
215+
216+ All integrations activate automatically when plugins are detected.
217+
218+ ## 🌃 Terminal Support
173219
174220SilkCircuit includes matching themes for popular terminals:
175221
@@ -180,7 +226,7 @@ cp extras/kitty.conf ~/.config/kitty/themes/silkcircuit.conf
180226cp extras/wezterm.lua ~ /.config/wezterm/colors/silkcircuit.lua
181227```
182228
183- ## 🎨 Color Palette
229+ ## 💜 Color Palette
184230
185231| Color | Hex | Preview |
186232| -------| -----| ---------|
@@ -193,29 +239,35 @@ cp extras/wezterm.lua ~/.config/wezterm/colors/silkcircuit.lua
193239| Yellow | ` #f1fa8c ` | ![ #f1fa8c] ( https://via.placeholder.com/20/f1fa8c/f1fa8c?text=+ ) |
194240| Orange | ` #ffb86c ` | ![ #ffb86c] ( https://via.placeholder.com/20/ffb86c/ffb86c?text=+ ) |
195241
196- ## 🔧 Troubleshooting
242+ ## 🛠️ Troubleshooting
197243
198- ** Theme not loading?**
244+ ** 🤔 Theme not loading?**
199245
200- - Ensure Neovim version is 0.8.0 or higher
201- - Add ` vim.opt.termguicolors = true ` to your config
202- - Check that the plugin is installed : ` :Lazy ` or ` :PackerStatus `
246+ - ⚡ Neovim 0.8.0+ required
247+ - 🎨 Add ` vim.opt.termguicolors = true ` to config
248+ - 📦 Verify plugin installation : ` :Lazy ` or ` :PackerStatus `
203249
204- ** Colors look wrong ?**
250+ ** 🎭 Colors incorrect ?**
205251
206- - Verify your terminal supports true colors
207- - Try a different terminal emulator
208- - Check terminal color settings
252+ - 🖥️ Terminal must support true colors
253+ - 🔄 Test with different terminal emulator
254+ - ⚙️ Verify terminal color settings
209255
210- ** Need help ?**
256+ ** 🏎️ Performance issues ?**
211257
212- - Run ` :checkhealth ` for diagnostics
213- - Check [ Issues ] ( https://github.com/hyperb1iss/silkcircuit-nvim/issues )
214- - Create a new issue with your config and error messages
258+ - 🩺 Run ` :checkhealth silkcircuit ` for diagnostics
259+ - 🔐 Check cache directory permissions
260+ - 🧹 Clear cache: ` :SilkCircuitClearCache `
215261
216- ## 🤝 Contributing
262+ ** 💭 Need help? **
217263
218- Contributions are welcome! Please feel free to submit issues and pull requests.
264+ - 💜 Run ` :checkhealth silkcircuit `
265+ - 📬 Check [ Issues] ( https://github.com/hyperb1iss/silkcircuit-nvim/issues )
266+ - 📝 Include config and error messages
267+
268+ ## 💖 Contributing
269+
270+ Contributions welcome! Submit issues and pull requests.
219271
220272``` bash
221273# Clone the repo
@@ -230,16 +282,18 @@ make test
230282make lint
231283```
232284
233- ## 📄 License
285+ See [ STYLE_GUIDE.md] ( STYLE_GUIDE.md ) and [ CLAUDE.md] ( CLAUDE.md ) for development guidelines.
286+
287+ ## 📜 License
234288
235289MIT License - see [ LICENSE] ( LICENSE ) for details.
236290
237291---
238292
239293<div align =" center " >
240294
241- Created by [ Stefanie Jane 🌠 ] ( https://github.com/hyperb1iss )
295+ 💜 Created by [ Stefanie Jane 🌟 ] ( https://github.com/hyperb1iss ) 💜
242296
243- If you love SilkCircuit, [ buy me a Monster Ultra Violet ⚡️ ] ( https://ko-fi.com/hyperb1iss )
297+ If you love SilkCircuit, [ buy me a Monster Ultra Violet 🟣 ] ( https://ko-fi.com/hyperb1iss )
244298
245299</div >
0 commit comments