984c4c699a
* feat: add setup and simplify logic * docs: update README * chore: add config styles * chore: simplify util function * docs: add identifiers to styles
56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
|
|
|
|
|
|
|
|
### About
|
|
|
|
A clean dark theme written in lua for neovim (0.7.2 or older).
|
|
|
|
### Features
|
|
|
|
- Support for numerous plugins
|
|
- Customizable
|
|
|
|
### Installation
|
|
|
|
Install with your favorite package manager:
|
|
|
|
[lazy](https://github.com/wbthomason/lazy.nvim)
|
|
|
|
``` lua
|
|
{
|
|
"tiagovla/tokyodark.nvim",
|
|
opts = {
|
|
-- custom options here
|
|
},
|
|
config = function(_, opts)
|
|
require("tokyodark").setup(opts) -- calling setup is optional
|
|
vim.cmd [[colorscheme tokyodark]]
|
|
end,
|
|
}
|
|
```
|
|
|
|
### Default configuration
|
|
|
|
```lua
|
|
local default_config = {
|
|
transparent_background = false, -- set background to transparent
|
|
gamma = 1.00, -- adjust the brightness of the theme
|
|
styles = {
|
|
comments = { italic = true }, -- style for comments
|
|
keywords = { italic = true }, -- style for keywords
|
|
identifiers = { italic = true }, -- style for identifiers
|
|
functions = {}, -- style for functions
|
|
variables = {}, -- style for variables
|
|
},
|
|
custom_highlights = {} or function(highlights, palette) return {} end, -- extend highlights
|
|
custom_palette = {} or function(palette) return {} end, -- extend palette
|
|
terminal_colors = true, -- enable terminal colors
|
|
}
|
|
```
|
|
|
|
### Inspiration
|
|
|
|
- [tokyonight-vim](https://github.com/ghifarit53/tokyonight-vim)
|
|
- [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)
|