chore(build): auto-generate vimdoc

This commit is contained in:
github-actions[bot] 2023-07-01 06:49:23 +00:00
parent 7a2acd1b41
commit d288f62bf6

View File

@ -1,4 +1,4 @@
*tokyonight.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 June 24
*tokyonight.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 July 01
==============================================================================
Table of Contents *tokyonight.nvim-table-of-contents*
@ -20,9 +20,13 @@ Table of Contents *tokyonight.nvim-table-of-contents*
==============================================================================
1. Tokyo Night *tokyonight.nvim-tokyo-night*
A dark and light 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.
A dark and light Neovim <https://github.com/neovim/neovim> theme written in Lua
<https://www.lua.org> ported from the Visual Studio Code TokyoNight
<https://github.com/enkia/tokyo-night-vscode-theme> theme. Includes
|tokyonight.nvim-extra| themes for Kitty
<https://sw.kovidgoyal.net/kitty/conf.html>, Alacritty
<https://github.com/alacritty/alacritty>, iTerm <https://iterm2.com/> and Fish
<https://fishshell.com/docs/current/index.html>.
STORM *tokyonight.nvim-tokyo-night-storm*
@ -39,11 +43,13 @@ DAY *tokyonight.nvim-tokyo-night-day*
FEATURES *tokyonight.nvim-tokyo-night-features*
- supports the latest Neovim 0.9.0 features
- terminal colors
- darker background for sidebar-like windows
- supports all major plugins
- TokyoNight |tokyonight.nvim-extras| for a lot of other apps
- Supports the latest Neovim <https://github.com/neovim/neovim>
0.9.0 <https://github.com/neovim/neovim/releases/tag/v0.9.0> features.
- Enhances terminal colors.
- Introduces a darker background option for sidebar-like windows.
- Supports all major plugins.
- Provides TokyoNight <https://github.com/folke/tokyonight.nvim>
|tokyonight.nvim-extras| numerous other applications.
EXTRAS ~
@ -72,14 +78,14 @@ EXTRAS ~
REQUIREMENTS *tokyonight.nvim-tokyo-night-requirements*
- Neovim >= 0.7.2
- Neovim <https://github.com/neovim/neovim> >=
0.7.2 <https://github.com/neovim/neovim/releases/tag/v0.7.2>
INSTALLATION *tokyonight.nvim-tokyo-night-installation*
Install the theme with your preferred package manager:
folke/lazy.nvim <https://github.com/folke/lazy.nvim>
Install the theme with your preferred package manager, such as folke/lazy.nvim
<https://github.com/folke/lazy.nvim>
>lua
{
@ -93,27 +99,34 @@ folke/lazy.nvim <https://github.com/folke/lazy.nvim>
USAGE *tokyonight.nvim-tokyo-night-usage*
Enable the colorscheme:
VIM SCRIPT ~
>vim
" Vim Script
colorscheme tokyonight
" There are also colorschemes for the different styles
" There are also colorschemes for the different styles.
colorscheme tokyonight-night
colorscheme tokyonight-storm
colorscheme tokyonight-day
colorscheme tokyonight-moon
<
LUA ~
>lua
-- Lua
vim.cmd[[colorscheme tokyonight]]
<
To enable the `tokyonight` theme for `Barbecue`
EXTERNAL PLUGINS
BARBECUE
>lua
-- Lua
require('barbecue').setup {
-- ... your barbecue config
theme = 'tokyonight',
@ -121,10 +134,11 @@ To enable the `tokyonight` theme for `Barbecue`
}
<
Toenable the `TokyoNight` theme for `Lualine`, simply specify it in your
lualine settings:
LUALINE
>lua
-- Lua
require('lualine').setup {
options = {
-- ... your lualine config
@ -134,7 +148,8 @@ lualine settings:
}
<
To enable the `tokyonight` colorscheme for `Lightline`
LIGHTLINE
>vim
" Vim Script
@ -145,17 +160,16 @@ To enable the `tokyonight` colorscheme for `Lightline`
CONFIGURATION *tokyonight.nvim-tokyo-night-configuration*
configuration needs to be set **BEFORE** loading the color scheme with
`colorscheme tokyonight`
The theme comes in four styles, `storm`, `moon`, a darker variant `night` and
`day`.
Set the configuration **BEFORE** loading the color scheme with `colorscheme
tokyonight`.
The theme offers four styles: |tokyonight.nvim-storm|, |tokyonight.nvim-moon|,
|tokyonight.nvim-night|, and |tokyonight.nvim-day|.
The **day** style will be used if:
The |tokyonight.nvim-day| style is used when `{ style = "day" }` is passed to
`setup(options)` or when `vim.o.background = "light"`.
- `{ style = "day"}` was passed to `setup(options)`
- or `vim.o.background = "light"`
TokyoNight will use the default options, unless you call `setup`.
TokyoNight <https://github.com/folke/tokyonight.nvim> uses the default options,
unless `setup` is explicitly called.
>lua
require("tokyonight").setup({
@ -164,7 +178,7 @@ TokyoNight will use the default options, unless you call `setup`.
style = "storm", -- The theme comes in three styles, `storm`, `moon`, a darker variant `night` and `day`
light_style = "day", -- The theme is used when the background is set to light
transparent = false, -- Enable this to disable setting the background color
terminal_colors = true, -- Configure the colors used when opening a `:terminal` in Neovim
terminal_colors = true, -- Configure the colors used when opening a `:terminal` in [Neovim](https://github.com/neovim/neovim)
styles = {
-- Style to be applied to different syntax groups
-- Value is any valid attr-list value for `:help nvim_set_hl`
@ -200,16 +214,19 @@ OVERRIDING COLORS & HIGHLIGHT GROUPS*tokyonight.nvim-tokyo-night-overriding-colo
How the highlight groups are calculated:
1. the **colors** for the style are calculated based on your config
2. `config.on_colors(colors)` is ran, where you can override the colors
3. the **colors** are then used to generate the highlight groups
4. `config.on_highlights(highlights, colors)` is ran, where you can overide the highlight groups
1. `colors` are determined based on your configuration, with the ability to
override them using `config.on_colors(colors)`.
2. These `colors` are utilized to generate the highlight groups.
3. `config.on_highlights(highlights, colors)` can be used to override highlight
groups.
Please refer to default values for `colors` and `highlights` for the storm
For default values of `colors` and `highlights`, please consult the storm
<extras/lua/tokyonight_storm.lua>, moon <extras/lua/tokyonight_moon.lua>, night
<extras/lua/tokyonight_night.lua>, day <extras/lua/tokyonight_day.lua>
<extras/lua/tokyonight_night.lua>, and day <extras/lua/tokyonight_day.lua>
themes.
Example for changing some settings and colors
SETTINGS AND COLOR ALTERATION DEMONSTRATION ~
>lua
require("tokyonight").setup({
@ -228,8 +245,8 @@ Example for changing some settings and colors
})
<
Example to make Telescope borderless
<https://github.com/nvim-telescope/telescope.nvim/wiki/Gallery#borderless>
BORDERLESS TELESCOPE EXAMPLE ~
>lua
require("tokyonight").setup({
@ -267,10 +284,10 @@ Example to make Telescope borderless
<
MAKING UNDERCURLS WORK PROPERLY IN TMUX ~
FIX UNDERCURLS IN TMUX ~
To have undercurls show up and in color, add the following to your **Tmux**
config file:
To have undercurls show up and in color, add the following to your Tmux
<https://github.com/tmux/tmux> configuration file:
>sh
Undercurl
@ -282,12 +299,14 @@ config file:
EXTRAS *tokyonight.nvim-tokyo-night-extras*
Extra color configs for **Kitty**, **Alacritty**, **Fish**, **WezTerm**,
**iTerm** and **foot** can be found in extras <extras/>. To use them, refer to
their respective documentation.
Extra color configs for Kitty <https://sw.kovidgoyal.net/kitty/conf.html>,
Alacritty <https://github.com/alacritty/alacritty>, Fish
<https://www.lua.org/>, WezTerm <https://wezfurlong.org/wezterm/config/>, iTerm
<https://iterm2.com/> and foot <https://codeberg.org/dnkl/foot> can be found in
extras <extras/>. To use them, refer to their respective documentation.
You can easily use the color palette for other plugins inside your Neovim
config:
<https://github.com/neovim/neovim> configuration:
>lua
local colors = require("tokyonight.colors").setup() -- pass in any of the config options as explained above
@ -300,27 +319,29 @@ config:
CONTRIBUTING *tokyonight.nvim-tokyo-night-contributing*
Pull requests are welcome. For the `extras`, we use a simple template system
that can be used to generate themes for the different styles.
Pull requests are welcome.
For the |tokyonight.nvim-extras|, we use a simple template system that can be
used to generate themes for the different styles.
How to add a new extra template:
1. create a file like `lua/tokyonight/extra/cool-app.lua`
1. Create a file like `lua/tokyonight/extra/cool-app.lua`.
2. add the name and output file extension to the `extras` table in
`lua/tokyonight/extra/init.lua`
2. Add the name and output file extension to the `extras` table in
`lua/tokyonight/extra/init.lua`.
3. run the shell script below to generate / update extra themes
3. Run the following command to generate new |tokyonight.nvim-extra| themes:
>sh
$ nvim --headless "+lua require('tokyonight.extra').setup()" +qa
nvim --headless "+lua require('tokyonight.extra').setup()" +qa
<
4. check the newly created themes under `extra/`, but **DO NOT** commit them! They
will be build automatically by the ci
4. Check the newly created themes in the `extra/` directory. Please **DO NOT**
commit them, as they are already automatically built by the CI.