Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxmx03/solarized.nvim
Solarized is a sixteen color palette (eight monotones, eight accent colors) designed for use with terminal and gui applications. Solarized port for Neovim
https://github.com/maxmx03/solarized.nvim
colorscheme lua neovim neovim-colorscheme neovim-plugin neovim-theme nvim-plugin selenized solarized
Last synced: 5 days ago
JSON representation
Solarized is a sixteen color palette (eight monotones, eight accent colors) designed for use with terminal and gui applications. Solarized port for Neovim
- Host: GitHub
- URL: https://github.com/maxmx03/solarized.nvim
- Owner: maxmx03
- License: mit
- Created: 2022-04-29T17:08:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T12:54:19.000Z (16 days ago)
- Last Synced: 2024-10-31T13:39:11.951Z (15 days ago)
- Topics: colorscheme, lua, neovim, neovim-colorscheme, neovim-plugin, neovim-theme, nvim-plugin, selenized, solarized
- Language: Lua
- Homepage: https://ethanschoonover.com/solarized/
- Size: 985 KB
- Stars: 144
- Watchers: 1
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Solarized
Solarized is a sixteen color palette (eight monotones, eight accent colors)
designed for use with terminal and gui applications.
[click here to learn more](https://ethanschoonover.com/solarized/)
- [Features](#features)
- [Requirements](#requirements)
- [Install from package manager](#install-from-package-manager)
- [Solarized's Annotations](#solarizeds-annotations)
- [Using `lspconfig`](#using-lspconfig)
- [Using `.luarc.json`](#using-luarcjson)
- [Manual Installation](#manual-installation)
- [Docs](#docs)
- [Commands](#commands)
- [Default Config](#default-config)
- [Config Variant](#config-variant)
- [Config Transparency](#config-transparency)
- [Config Styles](#config-styles)
- [Config Highlights](#config-highlights)
- [Config Colors](#config-colors)
- [Config Plugins](#config-plugins)
- [Config Error Lens](#config-error-lens)
- [Lualine](#lualine)
- [Barbecue](#barbecue)
- [Api](#api)
- [Contributing](#contributing)
- [Designed by](#designed-by)
- [Credits and Reference](#credits-and-reference)
## Features
- Support for Treesitter
- Support for Semantic highlight
- Customizability: styles, colors and highlights can all be modified
- Plugin compatibility
- Provides users with the option to enable or disable highlight groups
- Selenized color palette
## Requirements
Before using the Solarized Colorscheme, please make sure you have the following
requirements installed:
- `Neovim v0.9.1+`
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
## Install from package manager
Download using your preferred package manager.
[lazy](https://github.com/folke/lazy.nvim)
```lua
return {
'maxmx03/solarized.nvim',
lazy = false,
priority = 1000,
---@type solarized.config
opts = {},
config = function(_, opts)
vim.o.termguicolors = true
vim.o.background = 'light'
require('solarized').setup(opts)
vim.cmd.colorscheme 'solarized'
end,
}
```
[packer](https://github.com/wbthomason/packer.nvim)
```lua
use {
'maxmx03/solarized.nvim',
config = function()
vim.o.background = 'dark'
---@type solarized
local solarized = require('solarized')
vim.o.termguicolors = true
vim.o.background = 'dark'
solarized.setup({})
vim.cmd.colorscheme 'solarized'
end
}
```
## Solarized's Annotations
### Using `lspconfig`
```lua
local lsp_config = require 'lspconfig'
lsp_config.lua_ls.setup {
settings = {
Lua = {
hint = {
enable = true,
},
runtime = {
version = 'LuaJIT',
},
workspace = {
checkThirdParty = true,
library = {
vim.env.VIMRUNTIME,
'~/.local/share/nvim/lazy/solarized.nvim',
},
},
},
},
}
```
### Using `.luarc.json`
```json
{
"workspace.library": ["/path/to/nvim/runtime", "/path/to/solarized.nvim"]
}
```
## Manual Installation
To manually install Solarized, follow these steps:
1. Download the stable release of Solarized.
2. Extract the contents of the release.
3. Locate the following folders in the extracted files: `after`, `colors`,
`lua`, `plugin`.
4. Copy these folders to the `~/.config/nvim` directory.
## Docs
Use `:h solarized.nvim.txt` to see docs
## Commands
- `:Solarized colors` - Display the Solarized palette in a new buffer
## Default Config
```lua
vim.o.background = 'dark'
-- default config
require('solarized').setup({
transparent = {
enabled = false,
pmenu = true,
normal = true,
normalfloat = true,
neotree = true,
nvimtree = true,
whichkey = true,
telescope = true,
lazy = true,
},
on_highlights = nil,
on_colors = nil,
palette = 'solarized', -- solarized (default) | selenized
variant = 'winter', -- "spring" | "summer" | "autumn" | "winter" (default)
error_lens = {
text = false,
symbol = false,
},
styles = {
enabled = true,
types = {},
functions = {},
parameters = {},
comments = {},
strings = {},
keywords = {},
variables = {},
constants = {},
},
plugins = {
treesitter = true,
lspconfig = true,
navic = true,
cmp = true,
indentblankline = true,
neotree = true,
nvimtree = true,
whichkey = true,
dashboard = true,
gitsigns = true,
telescope = true,
noice = true,
hop = true,
ministatusline = true,
minitabline = true,
ministarter = true,
minicursorword = true,
notify = true,
rainbowdelimiters = true,
bufferline = true,
lazy = true,
rendermarkdown = true,
ale = true,
coc = true,
leap = true,
alpha = true,
yanky = true,
gitgutter = true,
mason = true,
flash = true,
},
})
vim.cmd.colorscheme = 'solarized'
```
## Config Variant
Solarized includes four variants: spring, summer, autumn, and winter.
[preview](https://github.com/maxmx03/solarized.nvim/blob/main/VARIANTS.md)
```lua
require('solarized').setup {
variant = 'winter', -- "spring" | "summer" | "autumn" | "winter" (default)
}
```
## Config Transparency
By default, transparency is turned off, but you can easily enable it and
customize which specific UI components should be transparent.
```lua
require('solarized').setup {
transparent = {
enabled = true, -- Master switch to enable transparency
pmenu = true, -- Popup menu (e.g., autocomplete suggestions)
normal = true, -- Main editor window background
normalfloat = true, -- Floating windows
neotree = true, -- Neo-tree file explorer
nvimtree = true, -- Nvim-tree file explorer
whichkey = true, -- Which-key popup
telescope = true, -- Telescope fuzzy finder
lazy = true, -- Lazy plugin manager UI
mason = true, -- Mason manage external tooling
},
}
```
## Config Styles
The `styles` config allows you to customize the style of a highlight
group.
```lua
---@type solarized.styles
local styles = {
comments = { italic = true, bold = false },
functions = { italic = true },
variables = { italic = false },
}
require('solarized').setup({
styles = styles,
})
```
You can also disable all highlight group styles.
```lua
require('solarized').setup({
styles = { enabled = false },
})
```
## Config Highlights
The `highlights` config allows you to customize the highlights groups.
example:
```lua
require('solarized').setup {
on_highlights = function (colors, color)
local darken = color.darken
local lighten = color.lighten
local blend = color.blend
local shade = color.shade
local tint = color.tint
---@type solarized.highlights
local groups = {
Visual = { bg = colors.base02, standout = true },
Function = { fg = colors.yellow },
IncSearch = { fg = colors.orange, bg = colors.mix_orange },
Search = { fg = colors.violet, bg = shade(colors.violet, 5) },
NormalFloat = { bg = darken(colors.base03, 25) }
}
return groups
end
}
```
## Config Colors
The `colors` config allows you to extend or modify the color palette used by
solarized.
> [!TIP]
> Use `:Solarized colors` to see available colors.
example:
```lua
require('solarized').setup {
on_colors = function(colors, color)
local lighten = color.tint
local darken = color.darken
return {
fg = lighten(colors.base00, 2),
bg = darken(colors.base03, 30)
}
end,
highlights = function(colors)
return {
Normal = { fg = colors.fg, bg = colors.bg }
}
end
}
```
## Config Plugins
The plugins config allows you to enable or disable solarized support for
spefic plugins or neovim's default highlights
example:
```lua
return {
'maxmx03/solarized.nvim',
lazy = false,
priority = 1000,
---@type solarized.config
opts = {
plugins = {
navic = false,
nvimtree = false,
dashboard = false,
noice = false,
ministatusline = false,
minitabline = false,
ministarter = false,
rainbowdelimiters = false,
}
},
config = function(_, opts)
require('solarized').setup(opts)
vim.cmd.colorscheme 'solarized'
end,
}
```
## Config Error Lens
Enables additional highlights for diagnostic virtual text and symbols.
```lua
return {
'maxmx03/solarized.nvim',
lazy = false,
priority = 1000,
---@type solarized.config
opts = {
error_lens = {
text = true,
symbol = true,
}
},
config = function(_, opts)
require('solarized').setup(opts)
vim.cmd.colorscheme 'solarized'
end,
}
```
## Lualine
```lua
require('lualine').setup {
options = {
theme = 'solarized',
-- theme = 'selenized',
disabled_filetypes = {
'NvimTree',
},
},
}
```
Alternatively, to utilize Lualine's Solarized theme:
```lua
require('lualine').setup {
options = {
theme = require('lualine.themes.solarized')
}
}
```
To use the Solarized theme showcased in the screenshot for Lualine [click here](https://github.com/maxmx03/solarized.nvim/discussions/50)
## Barbecue
```lua
require('barbecue').setup {
theme = 'solarized',
}
```
## Api
```lua
---@type solarized.palette
local colors = require('solarized.utils').get_colors()
---@type solarized.color
local color = require('solarized.color')
local darken = color.darken
local lighten = color.lighten
local blend = color.blend
local shade = color.shade
local tint = color.tint
-- example 1: get shades
for i = 1, 10, 1 do
print(shade(colors.yellow, i))
end
for i = 1, 100, 10 do
print(darken(colors.yellow, i))
end
-- example 2: get tints
for i = 1, 10, 1 do
print(tint(colors.yellow, i))
end
for i = 1, 100, 10 do
print(lighten(colors.yellow, i))
end
-- example 3: blend color
local new_color = blend(colors.yellow, colors.base03, 0.2)
```
## Contributing
Pull requests are welcome and appreciated.
## Designed by
[](https://github.com/altercation)
Ethan Schoonover
## Credits and Reference
- [solarized-vim](https://github.com/altercation/vim-colors-solarized)
- [tokyonight](https://github.com/folke/tokyonight.nvim)
[](https://github.com/glepnir)