https://github.com/hyperb1iss/silkcircuit-nvim
Vibrant cyberpunk-inspired Neovim theme with neon colors and extensive plugin support
https://github.com/hyperb1iss/silkcircuit-nvim
astronvim colorscheme cyberpunk developer-tools neon neovim neovim-colorscheme neovim-theme vim-colorscheme
Last synced: 11 months ago
JSON representation
Vibrant cyberpunk-inspired Neovim theme with neon colors and extensive plugin support
- Host: GitHub
- URL: https://github.com/hyperb1iss/silkcircuit-nvim
- Owner: hyperb1iss
- License: mit
- Created: 2025-07-25T18:45:18.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-27T03:14:35.000Z (11 months ago)
- Last Synced: 2025-07-27T05:22:30.680Z (11 months ago)
- Topics: astronvim, colorscheme, cyberpunk, developer-tools, neon, neovim, neovim-colorscheme, neovim-theme, vim-colorscheme
- Language: Lua
- Homepage: https://hyperbliss.tech
- Size: 671 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ๐โก SilkCircuit: Electric Dreams for Neovim ๐
[](https://neovim.io/)
[](https://www.lua.org/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/hyperb1iss/silkcircuit-nvim)
[](https://www.w3.org/WAI/WCAG21/quickref/)
[](https://github.com/hyperb1iss/silkcircuit-nvim)
[](https://github.com/hyperb1iss/silkcircuit-nvim#-plugin-support)
[](https://github.com/hyperb1iss/silkcircuit-nvim#-theme-variants)
๐ _Pure electric energy with vibrant purples, blazing pinks, and neon accents_ ๐
[โก Installation](#-installation) โข [๐ Features](#-features) โข [๐จ Configuration](#-configuration) โข [๐ฎ Plugin Support](#-plugin-support)
## ๐ญ Overview
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.
## ๐ฆ Features
- ๐ช **Electric Color System** โ Vibrant palette with semantic color mappings
- ๐๏ธ **<5ms Load Time** โ Bytecode compilation with intelligent caching
- ๐๏ธ **WCAG AA Compliant** โ Validated contrast ratios for extended coding sessions
- ๐๏ธ **Theme Variants** โ Neon (100%), Vibrant (85%), Soft (70%), and Glow (ultra-dark) modes
- ๐ฎ **40+ Plugin Integrations** โ Auto-detected support for your entire toolchain
- ๐พ **Persistent Preferences** โ Settings survive across sessions
## ๐ซ Installation
### ๐ฏ Using [lazy.nvim](https://github.com/folke/lazy.nvim) (Recommended)
```lua
{
"hyperb1iss/silkcircuit-nvim",
lazy = false,
priority = 1000,
config = function()
vim.cmd.colorscheme("silkcircuit")
end,
}
```
### ๐ฆ Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"hyperb1iss/silkcircuit-nvim",
config = function()
vim.cmd("colorscheme silkcircuit")
end
}
```
### ๐ฎ Using [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'hyperb1iss/silkcircuit-nvim'
colorscheme silkcircuit
```
## ๐ธ AstroNvim
SilkCircuit integrates seamlessly with AstroNvim, just like any community colorscheme:
```lua
-- In your lua/community.lua file:
return {
"AstroNvim/astrocommunity",
{ "hyperb1iss/silkcircuit-nvim", name = "silkcircuit" },
}
-- In your lua/plugins/astroui.lua file:
return {
"AstroNvim/astroui",
opts = {
colorscheme = "silkcircuit",
},
}
```
That's it! No additional configuration needed.
## ๐จ Configuration
### ๐ช Default Setup
```lua
require("silkcircuit").setup({
transparent = false, -- Enable transparent background
terminal_colors = true, -- Configure terminal colors
dim_inactive = false, -- Dim inactive windows
variant = "neon", -- Theme variant: "neon" | "vibrant" | "soft" | "glow"
styles = {
comments = { italic = true },
keywords = { bold = true },
functions = { bold = true, italic = true },
variables = {},
strings = { italic = true },
},
integrations = {
-- Auto-detected by default
telescope = true,
neotree = true,
notify = true,
cmp = true,
mini = true,
-- See :h silkcircuit-integrations for full list
},
})
```
### ๐ Theme Variants
Switch between intensity levels:
```lua
-- Via setup
require("silkcircuit").setup({
variant = "vibrant", -- "neon" | "vibrant" | "soft" | "glow"
})
-- Or use commands
:SilkCircuit neon -- 100% intensity
:SilkCircuit vibrant -- 85% intensity
:SilkCircuit soft -- 70% intensity
:SilkCircuit glow -- Ultra-dark backgrounds with pure neon colors
```
### ๐ Transparent Background
For a sleek, transparent look:
```lua
require("silkcircuit").setup({
transparent = true,
})
```
### ๐ฏ Custom Highlights
Override any highlight group:
```lua
require("silkcircuit").setup({
on_highlights = function(highlights, colors)
highlights.Function = { fg = colors.cyan, bold = true }
highlights.Comment = { fg = colors.gray, italic = true }
end,
})
```
## ๐ Plugin Support
SilkCircuit auto-detects and themes 40+ plugins:
**๐ฏ Core Functionality**
- ๐ญ Telescope โ Fuzzy finder
- ๐ณ Neo-tree โ File explorer
- ๐ก LSP โ Language servers
- ๐ฟ Treesitter โ Syntax highlighting
- ๐น nvim-cmp โ Completion
- ๐ฆ Mason โ Package manager
**๐ Navigation & Motion**
- โก Flash / Leap โ Jump motions
- ๐ฃ Harpoon โ File marks
- ๐๏ธ Which-Key โ Keybinding hints
- ๐ฆ Mini.jump โ Enhanced jumps
**๐ง Git & Development**
- ๐ Gitsigns โ Git indicators
- ๐ญ Neogit โ Git interface
- ๐ DAP โ Debugging
- ๐งน none-ls โ Formatting/linting
**๐ UI Components**
- ๐ Lualine โ Status line
- ๐ BufferLine โ Buffer tabs
- ๐ Notify / Noice โ Notifications
- ๐ช Alpha โ Dashboard
- ๐ Mini.statusline โ Minimal status
**๐จ Editor Enhancement**
- ๐ Rainbow Delimiters โ Bracket pairs
- ๐ Indent Blankline โ Indentation guides
- ๐ Mini.indentscope โ Active indent
- ๐ซ Mini.cursorword โ Word highlighting
All integrations activate automatically when plugins are detected.
## ๐ Complete Environment Setup
SilkCircuit extends beyond Neovim with matching themes for your entire development environment:
### ๐ฏ Quick Setup
```bash
# Get the complete SilkCircuit experience
git clone https://github.com/hyperb1iss/silkcircuit-nvim.git
cd silkcircuit-nvim
# Electric git colors with conventional commit support
cat extras/gitconfig >> ~/.gitconfig
# Terminal themes (choose your terminal)
cp extras/kitty.conf ~/.config/kitty/themes/silkcircuit.conf
cp extras/alacritty.yml ~/.config/alacritty/themes/silkcircuit.yml
cp extras/warp.yaml ~/.warp/themes/silkcircuit.yaml
# VSCode theme (all variants included)
cd extras/vscode && npx @vscode/vsce package
# Install the generated .vsix file in VSCode/Cursor
# System info theme
cp extras/macchina/silkcircuit.toml ~/.config/macchina/themes/
# AstroNvim integration
cp -r extras/astronvim/* ~/.config/nvim/lua/
```
### ๐ What's Included
- **๐จ VSCode Themes** - All 4 variants (Neon, Vibrant, Soft, Glow) for VSCode/Cursor
- **โก Git Configuration** - Electric colors with conventional commit highlighting
- **๐ฅ๏ธ Terminal Themes** - Alacritty, Kitty, Warp, Windows Terminal, iTerm2
- **๐ AstroNvim Integration** - Complete setup with enhanced components
- **๐ System Tools** - Macchina theme for system info display
- **๐จ Tool Configs** - FZF, Lualine, and more
See [extras/README.md](extras/README.md) for detailed setup instructions.
## ๐ Color Palette
| Color | Hex | Preview |
|-------|-----|---------|
| Background | `#0a0a0f` |  |
| Foreground | `#e0e0e0` |  |
| Purple | `#e135ff` |  |
| Pink | `#ff79c6` |  |
| Cyan | `#80ffea` |  |
| Green | `#50fa7b` |  |
| Yellow | `#f1fa8c` |  |
| Orange | `#ffb86c` |  |
## ๐ ๏ธ Troubleshooting
**๐ค Theme not loading?**
- โก Neovim 0.8.0+ required
- ๐จ Add `vim.opt.termguicolors = true` to config
- ๐ฆ Verify plugin installation: `:Lazy` or `:PackerStatus`
**๐ญ Colors incorrect?**
- ๐ฅ๏ธ Terminal must support true colors
- ๐ Test with different terminal emulator
- โ๏ธ Verify terminal color settings
**๐๏ธ Performance issues?**
- ๐ฉบ Run `:checkhealth silkcircuit` for diagnostics
- ๐ Check cache directory permissions
- ๐งน Clear cache: `:SilkCircuitClearCache`
**๐ญ Need help?**
- ๐ Run `:checkhealth silkcircuit`
- ๐ฌ Check [Issues](https://github.com/hyperb1iss/silkcircuit-nvim/issues)
- ๐ Include config and error messages
## ๐ฎ Commands
| Command | Description |
|---------|-------------|
| `:SilkCircuit {variant}` | Switch theme variant (neon/vibrant/soft/glow) |
| `:SilkCircuitContrast` | Check WCAG contrast compliance |
| `:SilkCircuitCompile` | Compile theme for performance |
| `:SilkCircuitIntegrations` | Show detected plugin integrations |
| `:checkhealth silkcircuit` | Run health check diagnostics |
## ๐ Contributing
Contributions welcome! Submit issues and pull requests.
```bash
# Clone the repo
git clone https://github.com/hyperb1iss/silkcircuit-nvim.git
cd silkcircuit-nvim
# Install dev dependencies
make setup
# Run tests and linting
make test
make lint
```
See [STYLE_GUIDE.md](STYLE_GUIDE.md) and [CLAUDE.md](CLAUDE.md) for development guidelines.
## ๐ License
MIT License - see [LICENSE](LICENSE) for details.
---
Created by [Stefanie Jane ๐ ](https://github.com/hyperb1iss)
If you love SilkCircuit, [buy me a Monster Ultra Violet โก](https://ko-fi.com/hyperb1iss)