tokyonight: add documentation

This commit is contained in:
Builditluc 2021-11-03 08:52:10 +01:00 committed by Pedro Alves
parent 0126307bbe
commit 396ed2a87f

View file

@ -0,0 +1,70 @@
# tokyonight
This plugin sets up the `tokyonight` colorscheme.
## Options
### `colorschemes.tokyonight.enable`
**Description**: Enable tokyonight
**Type***: `bool`
### `colorschemes.tokyonight.style`
**Description**: Theme style
**Type**: `nullOr (enum [ "storm" "night" "day" ])`
**Default**: `null`
### `colorschemes.tokyonight.terminalColors`
**Description**: Configure the colors used when opening a `:terminal` in Neovim
**Type**: `bool`
### `colorschemes.tokyonight.italicComments`
**Description**: Make comments italic
**Type**: `bool`
### `colorschemes.tokyonight.italicKeywords`
**Description**: Make keywords italic
**Type**: `bool`
### `colorschemes.tokyonight.italicFunctions`
**Description**: Make functions italic
**Type**: `bool`
### `colorschemes.tokyonight.italicVariables`
**Description**: Make variables and identifiers italic
**Type**: `bool`
### `colorschemes.tokyonight.transparent`
**Description**: Enable this to disable setting the background color
**Type**: `bool`
### `colorschemes.tokyonight.hideInactiveStatusline`
**Description**: Enabling this option will hide inactive statuslines and replace them with a thin border
**Type**: `bool`
### `colorschemes.tokyonight.transparentSidebar`
**Description**: Sidebar like windows like NvimTree get a transparent background
**Type**: `bool`
### `colorschemes.tokyonight.darkSidebar`
**Description**: Sidebar like windows like NvimTree get a darker background
**Type**: `bool`
### `colorschemes.tokyonight.darkFloat`
**Description**: Float windows like the lsp diagnostic windows get a darker background
**Type**: `bool`
### `colorschemes.tokyonight.lualineBold`
**Description**: When true, section headers in the lualine theme will be bold
**Type**: `bool`