An open API service indexing awesome lists of open source software.

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

Awesome Lists containing this project

README

          

# ๐Ÿ’œโšก SilkCircuit: Electric Dreams for Neovim ๐ŸŒƒ

[![Neovim](https://img.shields.io/badge/Neovim%200.8+-e135ff.svg?style=for-the-badge&logo=neovim&logoColor=white)](https://neovim.io/)
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-80ffea.svg?style=for-the-badge&logo=lua&logoColor=white)](https://www.lua.org/)
[![License](https://img.shields.io/badge/License-MIT-ff79c6?style=for-the-badge&logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/MIT)

[![Theme](https://img.shields.io/badge/Theme-SilkCircuit-e135ff?style=for-the-badge&logo=paintbrush&logoColor=white)](https://github.com/hyperb1iss/silkcircuit-nvim)
[![WCAG](https://img.shields.io/badge/WCAG%20AA-Compliant-50fa7b?style=for-the-badge&logo=accessibility&logoColor=white)](https://www.w3.org/WAI/WCAG21/quickref/)
[![Load Time](https://img.shields.io/badge/Load%20Time-<5ms-f1fa8c?style=for-the-badge&logo=lightning&logoColor=black)](https://github.com/hyperb1iss/silkcircuit-nvim)

[![Plugins](https://img.shields.io/badge/40+%20Plugins-Supported-bd93f9?style=for-the-badge&logo=puzzle-piece&logoColor=white)](https://github.com/hyperb1iss/silkcircuit-nvim#-plugin-support)
[![Variants](https://img.shields.io/badge/4%20Variants-Neon%20|%20Vibrant%20|%20Soft%20|%20Glow-ffb86c?style=for-the-badge&logo=swatchbook&logoColor=white)](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)


SilkCircuit Theme Preview

## ๐ŸŽญ 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` | ![#0a0a0f](https://placehold.co/20x20/0a0a0f/0a0a0f.png) |
| Foreground | `#e0e0e0` | ![#e0e0e0](https://placehold.co/20x20/e0e0e0/e0e0e0.png) |
| Purple | `#e135ff` | ![#e135ff](https://placehold.co/20x20/e135ff/e135ff.png) |
| Pink | `#ff79c6` | ![#ff79c6](https://placehold.co/20x20/ff79c6/ff79c6.png) |
| Cyan | `#80ffea` | ![#80ffea](https://placehold.co/20x20/80ffea/80ffea.png) |
| Green | `#50fa7b` | ![#50fa7b](https://placehold.co/20x20/50fa7b/50fa7b.png) |
| Yellow | `#f1fa8c` | ![#f1fa8c](https://placehold.co/20x20/f1fa8c/f1fa8c.png) |
| Orange | `#ffb86c` | ![#ffb86c](https://placehold.co/20x20/ffb86c/ffb86c.png) |

## ๐Ÿ› ๏ธ 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)