Installation
SilkCircuit requires Neovim 0.10+ with true color support enabled.
Prerequisites
Ensure true colors are enabled in your config:
lua
vim.opt.termguicolors = truePackage Managers
lazy.nvim (Recommended)
lua
{
"hyperb1iss/silkcircuit",
lazy = false,
priority = 1000,
config = function()
require("silkcircuit").setup({
-- your options here
})
vim.cmd.colorscheme("silkcircuit")
end,
}packer.nvim
lua
use {
"hyperb1iss/silkcircuit",
config = function()
require("silkcircuit").setup({})
vim.cmd("colorscheme silkcircuit")
end
}vim-plug
vim
Plug 'hyperb1iss/silkcircuit'
" In your config:
lua require("silkcircuit").setup({})
colorscheme silkcircuitAstroNvim Integration
SilkCircuit works with AstroNvim out of the box:
lua
-- In your lua/community.lua file:
return {
"AstroNvim/astrocommunity",
{ "hyperb1iss/silkcircuit", name = "silkcircuit" },
}
-- In your lua/plugins/astroui.lua file:
return {
"AstroNvim/astroui",
opts = {
colorscheme = "silkcircuit",
},
}Verifying Installation
After installation, run the health check:
vim
:checkhealth silkcircuitThis will verify:
- Neovim version compatibility
- True color support
- Theme loading status
- Plugin integrations
- WCAG contrast compliance
Troubleshooting
Theme not loading?
- Ensure Neovim 0.10 or newer is installed
- Add
vim.opt.termguicolors = trueto your config - Verify plugin installation with
:Lazyor:PackerStatus
Colors look wrong?
- Your terminal must support true colors (24-bit)
- Check your terminal's color settings
- Try a different terminal emulator
Performance issues?
- Run
:checkhealth silkcircuit - Set
vim.g.silkcircuit_debug = trueand restart to see the measured load time - Open an issue with that number and your plugin list
Next Steps
- Configuration: Customize the theme
- Theme Variants: Switch between variants
