docs: added docs on how to use the color palette for other plugins. Fixes #75

This commit is contained in:
Folke Lemaitre
2021-08-05 09:48:22 +02:00
parent 921770e89d
commit f25cd9e982

View File

@@ -119,7 +119,7 @@ The **day** style will be used if:
| tokyonight_transparent | `false` | Enable this to disable setting the background color |
| tokyonight_hide_inactive_statusline | `false` | Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard **StatusLine** and **LuaLine**. |
| tokyonight_sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `["qf", "vista_kind", "terminal", "packer"]` |
| tokyonight_transparent_sidebar | `false` | Sidebar like windows like `NvimTree` get a transparent background
| tokyonight_transparent_sidebar | `false` | Sidebar like windows like `NvimTree` get a transparent background |
| tokyonight_dark_sidebar | `true` | Sidebar like windows like `NvimTree` get a darker background |
| tokyonight_dark_float | `true` | Float windows like the lsp diagnostics windows get a darker background. |
| tokyonight_colors | `{}` | You can override specific color groups to use other groups or a hex color |
@@ -166,6 +166,16 @@ Extra color configs for **Kitty**, **Alacritty**, **Fish**, **WezTerm** and **iT
![image](https://user-images.githubusercontent.com/292349/115395546-d8d6f880-a198-11eb-98fb-a1194787701d.png)
You can easily use the color palette for other plugins inside your Neovim config:
```lua
local colors = require("tokyonight.colors").setup({}) -- pass in any of the config options as explained above
local utils = requires("tokyonight.util")
aplugin.background = colors.bg_dark
aplugin.my_error = util.brighten(colors.red1, 0.3)
```
## 🔥 Contributing
Pull requests are welcome. For the `extras`, we use a simple template system that can be used to generate themes for the different styles.