Ecosyste.ms: Awesome

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

https://github.com/Tsuzat/NeoSolarized.nvim

NeoSolarized colorscheme for NeoVim with full transparency
https://github.com/Tsuzat/NeoSolarized.nvim

lua neosolarized neovim neovim-plugin solarized-theme

Last synced: about 2 months ago
JSON representation

NeoSolarized colorscheme for NeoVim with full transparency

Lists

README

        

# ๐Ÿ–Œ NeoSolarized

A dark and light Neovim theme written in Lua ported from
[NeoSolarized](https://github.com/overcache/NeoSolarized) with better syntax highlighting. Includes
extra themes for Kitty, Alacritty, Wezterm, Konsole and Windows Terminal.

## Dark (Dark Theme with Transparency)
![Screenshot_20230430_084417](https://user-images.githubusercontent.com/70003855/235333907-c064208a-3975-404d-874b-58e5c52ee5f0.png)

## Dark
![Screenshot_20230430_084549](https://user-images.githubusercontent.com/70003855/235333913-ed7b5a20-d114-4963-96e9-1bf06f34440c.png)

## Light
![Screenshot_20230430_084640](https://user-images.githubusercontent.com/70003855/235333918-848cc7c1-8069-4156-abc4-41fde7283c15.png)

## ๐Ÿ”ฅ Features

- supports the latest Neovim 5.0 features like TreeSitter and LSP
- better syntax highlighting
- color configs for
[`Kitty`](https://sw.kovidgoyal.net/kitty/conf.html?highlight=include),
[`Alacritty`](https://github.com/alacritty/alacritty),
[`Konsole`](https://konsole.kde.org/) and
[`Wezterm`](https://github.com/wez/wezterm)
- **`lualine`** theme

### ๐Ÿงจ Plugin Support

- [Barbar](https://github.com/romgrk/barbar.nvim)
- [BufferLine](https://github.com/akinsho/nvim-bufferline.lua)
- [Dashboard](https://github.com/glepnir/dashboard-nvim)
- [Fern](https://github.com/lambdalisue/fern.vim)
- [Git Gutter](https://github.com/airblade/vim-gitgutter)
- [Git Signs](https://github.com/lewis6991/gitsigns.nvim)
- [Indent Blankline](https://github.com/lukas-reineke/indent-blankline.nvim)
- [LSP Diagnostics](https://neovim.io/doc/user/lsp.html)
- [LSP Saga](https://github.com/glepnir/lspsaga.nvim)
- [LSP Trouble](https://github.com/folke/lsp-trouble.nvim)
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
- [Mini](https://github.com/echasnovski/mini.nvim)
- [Neogit](https://github.com/TimUntersberger/neogit)
- [Neo-tree](https://github.com/nvim-neo-tree/neo-tree.nvim)
- [NvimTree](https://github.com/nvim-tree/nvim-tree.lua)
- [Scrollbar](https://github.com/petertriho/nvim-scrollbar)
- [Telescope](https://github.com/nvim-telescope/telescope.nvim)
- [TreeSitter](https://github.com/nvim-treesitter/nvim-treesitter)
- [WhichKey](https://github.com/liuchengxu/vim-which-key)
- [vim-sneak](https://github.com/justinmk/vim-sneak)

## โšก๏ธ Requirements

- Neovim >= 0.6.0

## ๐Ÿ’ก Installation

Install the theme with your preferred package manager:

#### [`vim-plug`](https://github.com/junegunn/vim-plug)

```vim
Plug 'Tsuzat/NeoSolarized.nvim', { 'branch': 'master' }
```

#### [`packer`](https://github.com/wbthomason/packer.nvim)

```lua
use ('Tsuzat/NeoSolarized.nvim')
```
**or** clone the project and install locally using packer.

First clone the project in you machine.
```sh
$ git clone https://github.com/Tsuzat/NeoSolarized.nvim
```
Install using packer
```lua
use ('path-to-NeoSolarized')
```
#### [`lazy.nvim`](https://github.com/folke/lazy.nvim)

```lua
{
"Tsuzat/NeoSolarized.nvim",
lazy = false, -- make sure we load this during startup if it is your main colorscheme
priority = 1000, -- make sure to load this before all the other start plugins
config = function()
vim.cmd [[ colorscheme NeoSolarized ]]
end
}
```

## โœจ Usage

Enable the colorscheme:

```vim
" Vim Script
colorscheme NeoSolarized
```

```lua
-- Lua
vim.cmd[[colorscheme NeoSolarized]]
```

To use the `NeoSolarized` theme for `Lualine`, simply specify it in your
lualine settings:

```lua
require('lualine').setup {
options = {
theme = 'NeoSolarized'
-- ... your lualine config
}
}
```

## โš™๏ธ Configuration

> โš ๏ธ configuration needs to be set **BEFORE** loading the color scheme with
> `colorscheme NeoSolarized`

The theme comes in two styles, `light` and `dark`.

NeoSolarized will use the default options, unless you call `setup`.
Here an example to set things up using default options.

```lua
local ok_status, NeoSolarized = pcall(require, "NeoSolarized")

if not ok_status then
return
end

-- Default Setting for NeoSolarized

NeoSolarized.setup {
style = "dark", -- "dark" or "light"
transparent = true, -- true/false; Enable this to disable setting the background color
terminal_colors = true, -- Configure the colors used when opening a `:terminal` in Neovim
enable_italics = true, -- Italics for different hightlight groups (eg. Statement, Condition, Comment, Include, etc.)
styles = {
-- Style to be applied to different syntax groups
comments = { italic = true },
keywords = { italic = true },
functions = { bold = true },
variables = {},
string = { italic = true },
underline = true, -- true/false; for global underline
undercurl = true, -- true/false; for global undercurl
},
-- Add specific hightlight groups
on_highlights = function(highlights, colors)
-- highlights.Include.fg = colors.red -- Using `red` foreground for Includes
end,
}
-- Set colorscheme to NeoSolarized
vim.cmd [[
try
colorscheme NeoSolarized
catch /^Vim\%((\a\+)\)\=:E18o
colorscheme default
set background=dark
endtry
]]
```
> **NOTE** that you can not use transparency with `light` mode.

## โฃ๏ธ Extras

Extra color configs for **Kitty**, **Alacritty**, **Wezterm** and **Konsole**
can be found in [extras](extras/). To use them, refer to
their respective documentation.

## ๐Ÿ’ฅ Contributing

Pull requests are welcome. One can add plugin and language specific highlight groups.

## ๐Ÿ… Inspiration

- Plugin Structure is heavily inspired from [Tokyonight](https://github.com/folke/tokyonight.nvim)
- Classic color palettes from [NeoSolarized](https://github.com/overcache/NeoSolarized)
- Love for Full Transparent NeoVim themes.