Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/craftzdog/solarized-osaka.nvim
🏯 A clean, dark Neovim theme written in Lua, with support for lsp, treesitter and lots of plugins.
https://github.com/craftzdog/solarized-osaka.nvim
neovim solarized theme vim vim-colorscheme
Last synced: about 2 months ago
JSON representation
🏯 A clean, dark Neovim theme written in Lua, with support for lsp, treesitter and lots of plugins.
- Host: GitHub
- URL: https://github.com/craftzdog/solarized-osaka.nvim
- Owner: craftzdog
- License: apache-2.0
- Created: 2023-09-15T02:29:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-04T02:02:37.000Z (3 months ago)
- Last Synced: 2024-07-11T19:26:15.054Z (2 months ago)
- Topics: neovim, solarized, theme, vim, vim-colorscheme
- Language: Lua
- Homepage:
- Size: 738 KB
- Stars: 586
- Watchers: 4
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - craftzdog/solarized-osaka.nvim - 🏯 A clean, dark Neovim theme written in Lua, with support for lsp, treesitter and lots of plugins. (Lua)
README
# 🏯 Solarized Osaka
One of the [Solarized](https://ethanschoonover.com/solarized/)-inspired dark theme for [Neovim](https://github.com/neovim/neovim) written in [Lua](https://www.lua.org).
## 🎨 More Colors
Ethan Schoonover originally created the [Solarized](https://en.wikipedia.org/wiki/Solarized) color scheme in 2011, featuring a set of 16 colors.
However, this assortment of colors falls short in providing adequate variations for additional signs, alerts, tooltips, and various other UI components made available by recent Neovim plugins.
Furthermore, the text colors in the original theme are somewhat too dark when displayed on modern, vibrant monitors.
Solarized Osaka improves upon this by introducing additional colors, enriching the overall theme to ensure compatibility with newer plugins and enhancing visibility on contemporary monitors.
The theme brightens the base colors slightly, creating a visually appealing and functional color palette.
Here is what the improved color palette looks like:
[A Figma design is available here](https://www.figma.com/file/6Wp5Puqtz7hbMJgYqOOJzb/Solarized-Osaka?type=design&node-id=0%3A1&mode=design&t=vEaGptGFJOLAafmB-1).
## ✨ Features
- Supports the latest [Neovim](https://github.com/neovim/neovim)
[0.9.0](https://github.com/neovim/neovim/releases/tag/v0.9.0) features.
- Enhances terminal colors.
- Introduces a darker background option for sidebar-like windows.
- Supports all major plugins.
## ⚡️ Requirements
- [Neovim](https://github.com/neovim/neovim) >=
[0.7.2](https://github.com/neovim/neovim/releases/tag/v0.7.2)
## 📦 Installation
Install the theme with your preferred package manager, such as
[folke/lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
"craftzdog/solarized-osaka.nvim",
lazy = false,
priority = 1000,
opts = {},
}
```
## 🚀 Usage
### Vim Script
```vim
colorscheme solarized-osaka
```
### [Lua](https://www.lua.org)
```lua
vim.cmd[[colorscheme solarized-osaka]]
```
## ⚙️ Configuration
> ❗️ Set the configuration **BEFORE** loading the color scheme with `colorscheme solarized-osaka`.
[Solarized Osaka](https://github.com/craftzdog/solarized-osaka.nvim) uses the default options,
unless `setup` is explicitly called.
```lua
require("solarized-osaka").setup({
-- your configuration comes here
-- or leave it empty to use the default settings
transparent = true, -- Enable this to disable setting the background color
terminal_colors = true, -- Configure the colors used when opening a `:terminal` in [Neovim](https://github.com/neovim/neovim)
styles = {
-- Style to be applied to different syntax groups
-- Value is any valid attr-list value for `:help nvim_set_hl`
comments = { italic = true },
keywords = { italic = true },
functions = {},
variables = {},
-- Background styles. Can be "dark", "transparent" or "normal"
sidebars = "dark", -- style for sidebars, see below
floats = "dark", -- style for floating windows
},
sidebars = { "qf", "help" }, -- Set a darker background on sidebar-like windows. For example: `["qf", "vista_kind", "terminal", "packer"]`
day_brightness = 0.3, -- Adjusts the brightness of the colors of the **Day** style. Number between 0 and 1, from dull to vibrant colors
hide_inactive_statusline = false, -- Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**.
dim_inactive = false, -- dims inactive windows
lualine_bold = false, -- When `true`, section headers in the lualine theme will be bold
--- You can override specific color groups to use other groups or a hex color
--- function will be called with a ColorScheme table
---@param colors ColorScheme
on_colors = function(colors) end,
--- You can override specific highlights to use other groups or a hex color
--- function will be called with a Highlights and ColorScheme table
---@param highlights Highlights
---@param colors ColorScheme
on_highlights = function(highlights, colors) end,
})
```
## 🪓 Overriding Colors & Highlight Groups
How the highlight groups are calculated:
1. `colors` are determined based on your configuration, with the ability to
override them using `config.on_colors(colors)`.
1. These `colors` are utilized to generate the highlight groups.
1. `config.on_highlights(highlights, colors)` can be used to override highlight
groups.
For default values of `colors` and `highlights`, please consult the
[colors.lua](lua/solarized-osaka/colors.lua) file.
### Settings and color alteration demonstration
```lua
require("solarized-osaka").setup({
-- disable italic for functions
styles = {
functions = {}
},
sidebars = { "qf", "vista_kind", "terminal", "packer" },
-- Change the "hint" color to the "orange" color, and make the "error" color bright red
on_colors = function(colors)
colors.hint = colors.orange
colors.error = "#ff0000"
end
})
```
### [Borderless Telescope](https://github.com/nvim-telescope/telescope.nvim/wiki/Gallery#borderless) example
```lua
require("solarized-osaka").setup({
on_highlights = function(hl, c)
local prompt = "#2d3149"
hl.TelescopeNormal = {
bg = c.bg_dark,
fg = c.fg_dark,
}
hl.TelescopeBorder = {
bg = c.bg_dark,
fg = c.bg_dark,
}
hl.TelescopePromptNormal = {
bg = prompt,
}
hl.TelescopePromptBorder = {
bg = prompt,
fg = prompt,
}
hl.TelescopePromptTitle = {
bg = prompt,
fg = prompt,
}
hl.TelescopePreviewTitle = {
bg = c.bg_dark,
fg = c.bg_dark,
}
hl.TelescopeResultsTitle = {
bg = c.bg_dark,
fg = c.bg_dark,
}
end,
})
```
### Fix `undercurls` in [Tmux](https://github.com/tmux/tmux)
To have undercurls show up and in color, add the following to your
[Tmux](https://github.com/tmux/tmux) configuration file:
```sh
# Undercurl
set -g default-terminal "${TERM}"
set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm' # undercurl support
set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m' # underscore colours - needs tmux-3.0
# Alacritty
set -as terminal-features ",alacritty:RGB"
```