farout.nvim/README.md
Luke Mitchell 2c2e923df5
Add support for vim-sneak (#7)
Add highlights to support the [vim-sneak] plugin.

[vim-sneak]: https://github.com/justinmk/vim-sneak
2021-04-21 14:48:06 -07:00

5.6 KiB
Raw Blame History

🏙 Tokyo Night

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

Storm

image

Night

image

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 two styles, storm and a darker variant night.

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
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: ["quickfix", "__vista__", "terminal"]
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.
-- Example config in Lua
vim.g.tokyonight_style = "night"
vim.g.tokyonight_italic_functions = true
vim.g.tokyonight_sidebars = { "quickfix", "__vista__", "terminal" }
" Example config in VimScript
let g:tokyonight_style = "night"
let g:tokyonight_italic_functions = true
let g:tokyonight_sidebars = [ "quickfix", "__vista__", "terminal" ]

🍭 Extras

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

image