thallada/farout.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

First stab at converting to farout palette

Browse Source 
Also renamed all/most instances of tokyonight to farout
This commit is contained in:
Tyler Hallada
2023-12-01 15:30:50 -05:00
parent f247ee700b
commit 1752319cc5
130 changed files with 18963 additions and 301 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
doc/tokyonight.nvim.txt → doc/farout.nvim.txt
View File

@@ -1,55 +1,39 @@
*tokyonight.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 October 25
farout.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 October 25
==============================================================================
Table of Contents *tokyonight.nvim-table-of-contents*
Table of Contents *farout.nvim-table-of-contents*
1. Tokyo Night |tokyonight.nvim-tokyo-night|
- Storm |tokyonight.nvim-tokyo-night-storm|
- Night |tokyonight.nvim-tokyo-night-night|
- Moon |tokyonight.nvim-tokyo-night-moon|
- Day |tokyonight.nvim-tokyo-night-day|
- Features |tokyonight.nvim-tokyo-night-features|
- Requirements |tokyonight.nvim-tokyo-night-requirements|
- Installation |tokyonight.nvim-tokyo-night-installation|
- Usage |tokyonight.nvim-tokyo-night-usage|
- Configuration |tokyonight.nvim-tokyo-night-configuration|
- Overriding Colors & Highlight Groups|tokyonight.nvim-tokyo-night-overriding-colors-&-highlight-groups|
- Extras |tokyonight.nvim-tokyo-night-extras|
- Contributing |tokyonight.nvim-tokyo-night-contributing|
1. FarOut |farout.nvim-tokyo-night|
- Features |farout.nvim-tokyo-night-features|
- Requirements |farout.nvim-tokyo-night-requirements|
- Installation |farout.nvim-tokyo-night-installation|
- Usage |farout.nvim-tokyo-night-usage|
- Configuration |farout.nvim-tokyo-night-configuration|
- Overriding Colors & Highlight Groups|farout.nvim-tokyo-night-overriding-colors-&-highlight-groups|
- Extras |farout.nvim-tokyo-night-extras|
- Contributing |farout.nvim-tokyo-night-contributing|
==============================================================================
1. Tokyo Night *tokyonight.nvim-tokyo-night*
1. Tokyo Night *farout.nvim-tokyo-night*
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://www.lua.org> ported from the Visual Studio Code FarOut
<https://github.com/enkia/tokyo-night-vscode-theme> theme. Includes
|tokyonight.nvim-extra| themes for Kitty
|farout.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*
NIGHT *tokyonight.nvim-tokyo-night-night*
MOON *tokyonight.nvim-tokyo-night-moon*
DAY *tokyonight.nvim-tokyo-night-day*
FEATURES *tokyonight.nvim-tokyo-night-features*
FEATURES *farout.nvim-tokyo-night-features*
- 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| for numerous other applications.
- Provides FarOut <https://github.com/folke/farout.nvim>
|farout.nvim-extras| for numerous other applications.
EXTRAS ~
@@ -77,20 +61,20 @@ EXTRAS ~
- Zathura <https://pwmt.org/projects/zathura/> (zathura <extras/zathura>)
REQUIREMENTS *tokyonight.nvim-tokyo-night-requirements*
REQUIREMENTS *farout.nvim-tokyo-night-requirements*
- 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*
INSTALLATION *farout.nvim-tokyo-night-installation*
Install the theme with your preferred package manager, such as folke/lazy.nvim
<https://github.com/folke/lazy.nvim>
>lua
{
"folke/tokyonight.nvim",
"thallada/farout.nvim",
lazy = false,
priority = 1000,
opts = {},
@@ -98,26 +82,26 @@ Install the theme with your preferred package manager, such as folke/lazy.nvim
<
USAGE *tokyonight.nvim-tokyo-night-usage*
USAGE *farout.nvim-tokyo-night-usage*
VIM SCRIPT ~
>vim
colorscheme tokyonight
colorscheme farout
" There are also colorschemes for the different styles.
colorscheme tokyonight-night
colorscheme tokyonight-storm
colorscheme tokyonight-day
colorscheme tokyonight-moon
" colorscheme farout-night
" colorscheme farout-storm
" colorscheme farout-day
" colorscheme farout-moon
<
LUA ~
>lua
vim.cmd[[colorscheme tokyonight]]
vim.cmd[[colorscheme farout]]
<
@@ -130,7 +114,7 @@ BARBECUE
-- Lua
require('barbecue').setup {
-- ... your barbecue config
theme = 'tokyonight',
theme = 'farout',
-- ... your barbecue config
}
<
@@ -143,7 +127,7 @@ LUALINE
require('lualine').setup {
options = {
-- ... your lualine config
theme = 'tokyonight'
theme = 'farout'
-- ... your lualine config
}
}
@@ -154,26 +138,26 @@ LIGHTLINE
>vim
" Vim Script
let g:lightline = {'colorscheme': 'tokyonight'}
let g:lightline = {'colorscheme': 'farout'}
<
CONFIGURATION *tokyonight.nvim-tokyo-night-configuration*
CONFIGURATION *farout.nvim-tokyo-night-configuration*
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|.
farout`.
The theme offers four styles: |farout.nvim-storm|, |farout.nvim-moon|,
|farout.nvim-night|, and |farout.nvim-day|.
The |tokyonight.nvim-day| style is used when `{ style = "day" }` is passed to
The |farout.nvim-day| style is used when `{ style = "day" }` is passed to
`setup(options)` or when `vim.o.background = "light"`.
TokyoNight <https://github.com/folke/tokyonight.nvim> uses the default options,
FarOut <https://github.com/folke/farout.nvim> uses the default options,
unless `setup` is explicitly called.
>lua
require("tokyonight").setup({
require("farout").setup({
-- your configuration comes here
-- or leave it empty to use the default settings
style = "storm", -- The theme comes in three styles, `storm`, `moon`, a darker variant `night` and `day`
@@ -211,7 +195,7 @@ unless `setup` is explicitly called.
<
OVERRIDING COLORS & HIGHLIGHT GROUPS*tokyonight.nvim-tokyo-night-overriding-colors-&-highlight-groups*
OVERRIDING COLORS & HIGHLIGHT GROUPS*farout.nvim-tokyo-night-overriding-colors-&-highlight-groups*
How the highlight groups are calculated:
@@ -230,7 +214,7 @@ themes.
SETTINGS AND COLOR ALTERATION DEMONSTRATION ~
>lua
require("tokyonight").setup({
require("farout").setup({
-- use the night style
style = "night",
-- disable italic for functions
@@ -250,7 +234,7 @@ SETTINGS AND COLOR ALTERATION DEMONSTRATION ~
BORDERLESS TELESCOPE EXAMPLE ~
>lua
require("tokyonight").setup({
require("farout").setup({
on_highlights = function(hl, c)
local prompt = "#2d3149"
hl.TelescopeNormal = {
@@ -298,7 +282,7 @@ To have undercurls show up and in color, add the following to your Tmux
<
EXTRAS *tokyonight.nvim-tokyo-night-extras*
EXTRAS *farout.nvim-tokyo-night-extras*
Extra color configs for Kitty <https://sw.kovidgoyal.net/kitty/conf.html>,
Alacritty <https://github.com/alacritty/alacritty>, Fish
@@ -311,35 +295,35 @@ You can easily use the color palette for other plugins inside your Neovim
<https://github.com/neovim/neovim> configuration:
>lua
local colors = require("tokyonight.colors").setup() -- pass in any of the config options as explained above
local util = require("tokyonight.util")
local colors = require("farout.colors").setup() -- pass in any of the config options as explained above
local util = require("farout.util")
aplugin.background = colors.bg_dark
aplugin.my_error = util.lighten(colors.red1, 0.3) -- number between 0 and 1. 0 results in white, 1 results in red1
<
CONTRIBUTING *tokyonight.nvim-tokyo-night-contributing*
CONTRIBUTING *farout.nvim-tokyo-night-contributing*
Pull requests are welcome.
For the |tokyonight.nvim-extras|, we use a simple template system that can be
For the |farout.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/farout/extra/cool-app.lua`.
2. Add the name and output file extension to the `extras` table in
`lua/tokyonight/extra/init.lua`.
`lua/farout/extra/init.lua`.
3. Run the following command to generate new |tokyonight.nvim-extra| themes from
the tokyonight plugin directory:
3. Run the following command to generate new |farout.nvim-extra| themes from
the farout plugin directory:
>sh
nvim --headless "+lua require('tokyonight.extra').setup()" +qa
nvim --headless "+lua require('farout.extra').setup()" +qa
<
@@ -349,13 +333,7 @@ commit them, as they are already automatically built by the CI.
==============================================================================
2. Links *tokyonight.nvim-links*
1. *image*: https://user-images.githubusercontent.com/292349/115295095-3a9e5080-a10e-11eb-9aed-6054488c46ce.png
2. *image*: https://user-images.githubusercontent.com/292349/115295327-7afdce80-a10e-11eb-89b3-2591262bf95a.png
3. *image*: https://user-images.githubusercontent.com/292349/190951628-10ba28a1-57ff-4479-8eab-47400a402242.png
4. *image*: https://user-images.githubusercontent.com/292349/115996270-78c6c480-a593-11eb-8ed0-7d1400b058f5.png
5. *image*: https://user-images.githubusercontent.com/292349/115395546-d8d6f880-a198-11eb-98fb-a1194787701d.png
2. Links *farout.nvim-links*
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>