Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yagua/nebulous.nvim
Minimalist Collection of Colorschemes for Neovim Written in Lua
https://github.com/yagua/nebulous.nvim
colorscheme dark dark-theme lua neovim nvim theme tree-sitter vim
Last synced: about 1 month ago
JSON representation
Minimalist Collection of Colorschemes for Neovim Written in Lua
- Host: GitHub
- URL: https://github.com/yagua/nebulous.nvim
- Owner: Yagua
- License: mit
- Created: 2021-03-24T12:32:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T03:57:42.000Z (over 1 year ago)
- Last Synced: 2024-10-09T23:23:43.880Z (about 1 month ago)
- Topics: colorscheme, dark, dark-theme, lua, neovim, nvim, theme, tree-sitter, vim
- Language: Lua
- Homepage:
- Size: 5.62 MB
- Stars: 184
- Watchers: 3
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nebulous.nvim
Minimalist Collection of Colorschemes Written in Lua
## Features
- 6 available variants (for the moment)
- It has support for a large number of plugins such as LSP, Tree-Sitter, Telescope, Nvim-Tree and others.
- Support for Vim Terminal Colors
- Lualine scheme
- Color customization
- Italic elements in the editor
- Fun built-in functions
- They support a large number of terminal emulation environments, such as:
- [Alacritty](https://github.com/alacritty/alacritty)
- [Kitty](https://github.com/kovidgoyal/kitty)
- [Tmux](https://github.com/tmux/tmux)
- [Windows Terminal](https://github.com/microsoft/terminal)
## Prequisites
- [Neovim version 0.8+](https://github.com/neovim/neovim/releases)
- (Recommended) [Tree-Sitter](https://github.com/nvim-treesitter/nvim-treesitter) Highlight for a better use of colors
## Preview
Screenshots
#### Fullmoon
#### Midnight
#### Nova
#### Twilight
#### Night
#### Quasar
## Installation
You can install colorsecheme with any package manager, for example:
##### [Packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use 'Yagua/nebulous.nvim'
```
##### [Vim Plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'Yagua/nebulous.nvim'
```
## Configuration & Use
Setup example:
```lua
--Put this lines inside your vimrc to set the colorscheme
require("nebulous").setup {
variant = "midnight",
disable = {
background = true,
endOfBuffer = false,
terminal_colors = false,
},
italic = {
comments = false,
keywords = true,
functions = false,
variables = true,
},
custom_colors = { -- this table can hold any group of colors with their respective values
LineNr = { fg = "#5BBBDA", bg = "NONE", style = "NONE" },
CursorLineNr = { fg = "#E1CD6C", bg = "NONE", style = "NONE" },
-- it is possible to specify only the element to be changed
TelescopePreviewBorder = { fg = "#A13413" },
LspDiagnosticsDefaultError = { bg = "#E11313" },
TSTagDelimiter = { style = "bold,italic" },
}
```
When overwriting the color groups of the selected variant, it is possible to
obtain their colors or those of another variant as follows:
```lua
local colors = require("nebulous.functions").get_colors("midnight") -- < variant name
-- if you want to get the colors of the current variant use the function without arguments
require("nebulous").setup {
...
custom_colors = {
Normal = { fg = colors.Red, bg = colors.Black, style = colors.none },
},
}
-- the '...' is used to denote the existence of other settings, this is not language syntax.
```
## Summary of options
| Option | Default Value | Description |
| -------------------------------------|---------------|------------------------------------------------|
| variant | `night` | Select color variant |
| disable.background | `false` | Enable/Disable background in the editor |
| disable.endOfBuffer | `false` | Enable/Disable lines at the end of the buffer |
| disable.terminal_colors | `false` | Enable/Disable terminal colors |
| italic.comments | `false` | Enable/Disable "italic" style in comments |
| italic.functions | `false` | Enable/Disable "italic" style in functions |
| italic.variables | `false` | Enable/Disable "italic" style in variables |
| italic.keywords | `false` | Enable/Disable "italic" style in keywords |
| custom_colors | `{}` | Set custom colors for editor and plugin groups |
#### Color variants
| Variant | Value |
| --------------------| --------------|
| night | `default` |
| twilight | `alternative` |
| midnight | `alternative` |
| fullmoon | `alternative` |
| nova | `alternative` |
| quasar | `alternative` |
### Lualine scheme
If you want to use the custom colorscheme of lualine, put the following code in
your init (make sure you have nebulous and [lualine](https://github.com/hoob3rt/lualine.nvim)
installed):
```lua
require('lualine').setup {
options = {
-- theme name
theme = 'nebulous'
}
}
```
## Functions
| Option | Description |
| -------------------------------------|----------------------------------------------------------------------------|
| `toggle_variant` | Browse among the different variants |
| `random_variant` | Set a random variant among the different variants |
| `set_variant` | Set a specific variant according to its name |
| `get_colors` | Get the colors of the current variant or the variant specified as argument |
##### Toggle variant
To switch between styles just run the function, e.g:
```vim
:lua require("nebulous.functions").toggle_variant()
```
The random function has a similar behavior, just call the function as well:
```vim
:lua require("nebulous.functions").random_variant()
```
You can also set a specific variant based on its name:
```vim
:lua require("nebulous.functions").set_variant("variant_name")
```
The functions can be mapped for quick use, e.g:
- Vimscript
```vim
nnoremap tc :lua require("nebulous.functions").toggle_variant()
nnoremap rc :lua require("nebulous.functions").random_variant()
nnoremap tw :lua require("nebulous.functions").set_variant("variant_name")
```
- Lua
```lua
local setmap = vim.api.nvim_set_keymap
local options = { silent = true, noremap = true }
setmap("n", "tc", ":lua require('nebulous.functions').toggle_variant()", options)
setmap("n", "rc", ":lua require('nebulous.functions').random_variant()", options)
setmap("n", "tw", ":lua require('nebulous.functions').set_variant('variant_name')", options)
```
More features and color variants are coming in future updates!
### NOTE
- In case you find an error in any color scheme, please make an appropriate issue describing in detail the problem found.
- Also, if you want to make any contribution, please make the PR descriptive for easy integration.
I hope you enjoy these color schemes!