Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NTBBloodbath/sweetie.nvim
A clean, delightful and highly customizable Neovim colorscheme written in Lua
https://github.com/NTBBloodbath/sweetie.nvim
colorscheme neovim neovim-plugin
Last synced: 3 months ago
JSON representation
A clean, delightful and highly customizable Neovim colorscheme written in Lua
- Host: GitHub
- URL: https://github.com/NTBBloodbath/sweetie.nvim
- Owner: NTBBloodbath
- License: gpl-3.0
- Created: 2023-02-27T03:24:50.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-18T15:38:57.000Z (4 months ago)
- Last Synced: 2024-07-18T19:59:59.612Z (4 months ago)
- Topics: colorscheme, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 124 KB
- Stars: 93
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sweetie.nvim
A clean, delightful and highly customizable Neovim colorscheme written in Lua that
includes [extra themes](./extras) for other software like Kitty and WezTerm terminal
emulators, FISH shell and some others.
Sweetie has a great contrast that is friendly with your eyes, every color was selected
by hand after a long day testing different colors one by one and comparing them.
> sweetie.nvim requires at least Neovim `>=
0.7.2` in order to work!
---
dark variant
light variant
## Installation
- [`rocks.nvim`](https://github.com/nvim-neorocks/rocks.nvim):
```vim
:Rocks install sweetie.nvim
```
- [`packer.nvim`](https://github.com/wbthomason/packer.nvim):
```lua
use("NTBBloodbath/sweetie.nvim")
```
- [`lazy.nvim`](https://github.com/folke/lazy.nvim):
```lua
require("lazy").setup({
{ "NTBBloodbath/sweetie.nvim" }
})
```
## Usage
Just set the colorscheme in your configuration:
```lua
vim.cmd.colorscheme("sweetie")
```
You can also use the following method if you're using [`rocks-config.nvim`](https://github.com/nvim-neorocks/rocks-config.nvim) with your `rocks.nvim` installation:
```toml
[config]
colorscheme = "sweetie"
```
> If you want to use light variant you can just change your `background` Neovim option to `light`.
You can customize sweetie by using the `vim.g.sweetie` table, too. Please note that you should
call it before setting up sweetie as your colorscheme.
```lua
--- Default configuration
vim.g.sweetie = {
-- Pop-up menu pseudo-transparency
-- It requires `pumblend` option to have a non-zero value
pumblend = {
enable = true,
transparency_amount = 20,
},
-- Override default sweetie color palettes
-- Palette fields:
-- bg
-- fg
-- bg_hl
-- bg_alt
-- fg_alt
-- grey
-- dark_grey
-- red
-- orange
-- green
-- teal
-- yellow
-- blue
-- magenta
-- violet
-- cyan
palette = {
dark = {},
light = {},
},
-- Override default highlighting groups options
overrides = {},
-- Custom plugins highlighting groups
integrations = {
lazy = true,
neorg = true,
neogit = true,
neomake = true,
telescope = true,
},
-- Enable custom cursor coloring even in terminal Neovim sessions
cursor_color = true,
-- Use sweetie's palette in `:terminal` instead of your default terminal colorscheme
terminal_colors = true,
}
```
If you want to override any highlighting group, you can use the `overrides` field in
the configuration table. For example, to disable italics in the colorscheme:
```lua
overrides = {
Comment = { italic = false },
CommentBold = { italic = false },
Keyword = { italic = false },
Boolean = { italic = false },
Class = { italic = false },
-- Optional, just if you use Java and you do not want some extra italics
-- ["@type.java"] = { italic = false },
-- ["@type.qualifier.java"] = { italic = false },
}
```
> Every `overrides` field accept all the `:h nvim_set_hl` parameters.
## Roadmap
- [x] Add light theme variant
- [x] Allow to override default color palette
- [ ] Add more extra themes
- [ ] bat
- [x] termux
- [x] fish shell
- [x] florisboard
- [x] windows terminal
## License
As always, this project is licensed under [GPLv3](./LICENSE) license.