farout.nvim/README.md
2021-04-24 22:24:40 +02:00

6.2 KiB
Raw Blame History

🏙 Tokyo Night

A dark and light Neovim theme written in Lua ported from the Visual Studio Code TokyoNight theme. Includes extra themes for Kitty, Alacritty, iTerm and Fish.

Storm

image

Night

image

Day

Features

  • supports the latest Neovim 5.0 features like TreeSitter and LSP
  • minimal inactive statusline
  • vim terminal colors
  • darker background for sidebar-like windows
  • color configs for Kitty, Alacritty and Fish Shell
  • lualine theme

Plugin Support

Requirements

  • Neovim >= 0.5.0

📦 Installation

Install the theme with your preferred package manager:

vim-plug

Plug 'folke/tokyonight.nvim'

packer

use 'folke/tokyonight.nvim'

🚀 Usage

Enable the colorscheme:

" Vim Script
colorscheme tokyonight
-- Lua
vim.cmd[[colorscheme tokyonight]]

To enable the TokyoNight theme for Lualine, simply specify it in your lualine settings:

require('lualine').setup {
  options = {
    -- ... your lualine config
    theme = 'tokyonight'
    -- ... your lualine config
  }
}

⚙️ Configuration

The theme comes in three styles, storm, a darker variant night and day.

Option Default Description
tokyonight_style "storm" The theme comes in three styles, storm, a darker variant night and day.
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
tokyonight_italic_variables false Make variables and identifiers italic
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_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
-- Example config in Lua
vim.g.tokyonight_style = "night"
vim.g.tokyonight_italic_functions = true
vim.g.tokyonight_sidebars = { "qf", "vista_kind", "terminal", "packer" }

-- Change the "hint" color to the "orange" color, and make the "error" color bright red
vim.g.tokyonight_colors = { hint = "orange", error = "#ff0000" }
" Example config in VimScript
let g:tokyonight_style = "night"
let g:tokyonight_italic_functions = true
let g:tokyonight_sidebars = [ "qf", "vista_kind", "terminal", "packer" ]

🍭 Extras

Extra color configs for Kitty, Alacritty, Fish and iTerm can be found in extras. To use them, refer to their respective documentation.

image