From 396ed2a87fab1b290c76584b26d37b409883392f Mon Sep 17 00:00:00 2001 From: Builditluc <37375448+Builditluc@users.noreply.github.com> Date: Wed, 3 Nov 2021 08:52:10 +0100 Subject: [PATCH] tokyonight: add documentation --- doc/plugins/colorschemes/tokyonight.md | 70 ++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 doc/plugins/colorschemes/tokyonight.md diff --git a/doc/plugins/colorschemes/tokyonight.md b/doc/plugins/colorschemes/tokyonight.md new file mode 100644 index 00000000..efb53b11 --- /dev/null +++ b/doc/plugins/colorschemes/tokyonight.md @@ -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`