gruber-darker.nvim/README.md

92 lines
1.8 KiB
Markdown
Raw Normal View History

2023-01-10 21:11:37 +01:00
# gruber-darker.nvim
2023-01-11 04:13:59 +01:00
_A modern Neovim port of a deftheme [adaptation][gruber-darker-theme] of an Emacs
2023-01-11 03:14:06 +01:00
[port][gruber-darker] of a BBEdit [colorscheme][gruber-dark]_
2023-01-10 21:11:37 +01:00
> **Note**
> This is a work in progress, but fairly stable
2023-01-11 04:08:54 +01:00
2023-04-03 05:12:18 +02:00
![image](https://user-images.githubusercontent.com/9439488/229402983-b27a2fc4-d938-4ed0-8f7f-7711f73aa985.png)
2023-03-30 04:06:31 +02:00
2023-01-10 21:27:06 +01:00
## Installation
### Lazy (recommended)
```lua
{ "blazkowolf/gruber-darker.nvim" }
```
2023-01-10 21:27:06 +01:00
### Packer
```lua
use "blazkowolf/gruber-darker.nvim"
2023-01-10 21:27:06 +01:00
```
### Plug
```vim
Plug 'blazkowolf/gruber-darker.nvim'
```
Then, somewhere in your `init.lua`, set the colorscheme
2023-01-11 03:14:06 +01:00
```lua
vim.cmd.colorscheme("gruber-darker")
2023-01-11 03:14:06 +01:00
```
## Configuration
### Defaults
```lua
{
bold = true,
2023-03-30 06:13:32 +02:00
invert = {
signs = false,
2023-03-30 03:50:44 +02:00
},
italic = {
strings = true,
comments = true,
operators = false,
folds = true,
},
2023-03-30 03:50:44 +02:00
undercurl = true,
underline = true,
}
```
### With updated preferences
Change configuration options by calling `setup()`
prior to loading the colorscheme. Your preferences
will be merged with the defaults.
For example, with [Lazy](https://github.com/folke/lazy.nvim.git)...
```lua
{
"blazkowolf/gruber-darker.nvim",
opts = {
bold = false,
italic = {
strings = false,
},
},
}
```
## Credits
2023-01-11 03:14:06 +01:00
These repositories were great knowledge sources and their
inspiration helped immensely with the development of this plugin.
2023-01-11 03:14:06 +01:00
- [rexim/gruber-darker-theme][gruber-darker-theme]
- [folke/tokyonight.nvim][tokyonight]
- [drsooch/gruber-darker-vim][gruber-darker-vim]
2023-01-11 03:14:06 +01:00
2023-01-10 21:27:06 +01:00
[gruber-darker-theme]: https://github.com/rexim/gruber-darker-theme
2023-01-10 21:30:41 +01:00
[gruber-darker]: https://jblevins.org/projects/emacs-color-themes/gruber-darker-theme.el.html
2023-01-10 21:27:06 +01:00
[gruber-dark]: http://daringfireball.net/projects/bbcolors/schemes/
2023-01-11 03:14:06 +01:00
[tokyonight]: https://github.com/folke/tokyonight.nvim
[gruber-darker-vim]: https://github.com/drsooch/gruber-darker-vim