2021-04-19 19:40:12 +00:00
# 🏙 Tokyo Night
2021-04-21 21:49:44 +00:00
A dark Neovim theme written in Lua ported from the Visual Studio Code [TokyoNight ](https://github.com/enkia/tokyo-night-vscode-theme ) theme. Includes extra themes for Kitty, Alacritty, iTerm and Fish.
2021-04-19 19:40:12 +00:00
2021-04-19 19:55:58 +00:00
## Storm
![image ](https://user-images.githubusercontent.com/292349/115295095-3a9e5080-a10e-11eb-9aed-6054488c46ce.png )
## Night
![image ](https://user-images.githubusercontent.com/292349/115295327-7afdce80-a10e-11eb-89b3-2591262bf95a.png )
2021-04-19 19:40:12 +00:00
## ✨ Features
2021-04-20 11:39:38 +00:00
+ supports the latest Neovim 5.0 features like TreeSitter and LSP
+ minimal inactive statusline
+ vim terminal colors
+ darker background for sidebar-like windows
2021-04-20 12:47:35 +00:00
+ color configs for [Kitty ](https://sw.kovidgoyal.net/kitty/conf.html?highlight=include ), [Alacritty ](https://github.com/alacritty/alacritty ) and [Fish Shell ](https://fishshell.com/ )
2021-04-20 11:39:38 +00:00
+ **lualine** theme
### Plugin Support
2021-04-19 19:40:12 +00:00
+ [TreeSitter ](https://github.com/nvim-treesitter/nvim-treesitter )
+ [LSP Diagnostics ](https://neovim.io/doc/user/lsp.html )
2021-04-22 15:43:46 +00:00
+ [LSP Trouble ](https://github.com/folke/lsp-trouble.nvim )
2021-04-19 19:40:12 +00:00
+ [LSP Saga ](https://github.com/glepnir/lspsaga.nvim )
+ [Git Signs ](https://github.com/lewis6991/gitsigns.nvim )
+ [Git Gutter ](https://github.com/airblade/vim-gitgutter )
+ [Telescope ](https://github.com/nvim-telescope/telescope.nvim )
+ [NvimTree ](https://github.com/kyazdani42/nvim-tree.lua )
+ [WhichKey ](https://github.com/liuchengxu/vim-which-key )
+ [Indent Blankline ](https://github.com/lukas-reineke/indent-blankline.nvim )
+ [Dashboard ](https://github.com/glepnir/dashboard-nvim )
+ [BufferLine ](https://github.com/akinsho/nvim-bufferline.lua )
2021-04-20 11:39:38 +00:00
+ [Lualine ](https://github.com/hoob3rt/lualine.nvim )
2021-04-21 07:06:52 +00:00
+ [Neogit ](https://github.com/TimUntersberger/neogit )
2021-04-21 21:48:06 +00:00
+ [vim-sneak ](https://github.com/justinmk/vim-sneak )
2021-04-19 19:40:12 +00:00
2021-04-21 06:05:13 +00:00
## ⚡️ Requirements
+ Neovim >= 0.5.0
2021-04-19 19:40:12 +00:00
## 📦 Installation
Install the theme with your preferred package manager:
[vim-plug ](https://github.com/junegunn/vim-plug )
```vim
Plug 'folke/tokyonight.nvim'
```
[packer ](https://github.com/wbthomason/packer.nvim )
```lua
use 'folke/tokyonight.nvim'
```
## 🚀 Usage
Enable the colorscheme:
```vim
" Vim Script
colorscheme tokyonight
```
```lua
-- Lua
vim.cmd[[colorscheme tokyonight]]
```
To enable the `TokyoNight` theme for `Lualine` , simply specify it in your lualine settings:
```lua
require('lualine').setup {
2021-04-20 21:04:05 +00:00
options = {
-- ... your lualine config
theme = 'tokyonight'
-- ... your lualine config
}
2021-04-19 19:40:12 +00:00
}
```
## ⚙️ Configuration
The theme comes in two styles, `storm` and a darker variant `night` .
2021-04-20 10:19:20 +00:00
| Option | Default | Description |
| ----------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| tokyonight_style | `"storm"` | The theme comes in two styles, `"storm"` and a darker variant `"night"` . |
| tokyonight_terminal_colors | `true` | Configure the colors used when opening a `:terminal` in Neovim |
| tokyonight_italic_comments | `true` | Make comments italic |
| tokyonight_italic_keywords | `true` | Make keywords italic |
| tokyonight_italic_functions | `false` | Make functions italic |
2021-04-21 21:56:40 +00:00
| tokyonight_italic_variables | `false` | Make variables and identifiers italic |
2021-04-20 10:19:20 +00:00
| 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** . |
2021-04-23 15:30:19 +00:00
| tokyonight_sidebars | `{}` | Set a darker background on sidebar-like windows. For example: `["qf", "vista_kind", "terminal", "packer"]` |
2021-04-20 20:43:54 +00:00
| 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. |
2021-04-23 06:48:26 +00:00
| tokyonight_cterm_colors | `false` | Enabling this, will use the `gui` colors to set `cterm` values to their nearest equivalent. Only needed when not using terminal colors |
2021-04-20 05:47:36 +00:00
2021-04-20 10:19:20 +00:00
```lua
-- Example config in Lua
vim.g.tokyonight_style = "night"
vim.g.tokyonight_italic_functions = true
2021-04-23 15:17:52 +00:00
vim.g.tokyonight_sidebars = { "qf", "vista_kind", "terminal", "packer" }
2021-04-19 19:40:12 +00:00
```
2021-04-20 05:47:36 +00:00
```vim
2021-04-20 10:19:20 +00:00
" Example config in VimScript
let g:tokyonight_style = "night"
let g:tokyonight_italic_functions = true
2021-04-23 15:17:52 +00:00
let g:tokyonight_sidebars = [ "qf", "vista_kind", "terminal", "packer" ]
2021-04-20 05:47:36 +00:00
```
2021-04-20 11:39:38 +00:00
## 🍭 Extras
2021-04-20 18:38:05 +00:00
Extra color configs for **Kitty** , **Alacritty** , **Fish** and **iTerm** can be found in [extras ](extras/ ). To use them, refer to their respective documentation.
2021-04-20 12:26:02 +00:00
![image ](https://user-images.githubusercontent.com/292349/115395546-d8d6f880-a198-11eb-98fb-a1194787701d.png )