*everforest.txt* Comfortable & Pleasant Color Scheme for Vim

CONTENTS *everforest-contents*

Introduction |everforest-introduction|

Installation |everforest-installation|

Usage |everforest-usage|

Configuration |everforest-configuration|

FAQ |everforest-faq|

Note: Type |gO| in neovim to show the outline of contents.

INTRODUCTION *everforest-introduction*

Everforest is a green based color scheme; it's designed to be warm and soft

in order to protect developers' eyes.

- Green based but warm-toned.

- Designed to have soft contrast for eye protection.

- Works well with [redshift](https://github.com/jonls/redshift) and [f.lux](https://justgetflux.com).

- Customizable.

- Rich support for common file types and plugins.

- Tree-sitter support.

- Semantic highlighting support.

- Italic support 🎉

INSTALLATION *everforest-installation*

Note: For better syntax highlighting support, consider installing one of the

following plugins additionally to this colorscheme:

https://github.com/sheerun/vim-polyglot

https://github.com/nvim-treesitter/nvim-treesitter.

Via a Plugin Manager

VIM-PLUG

Refer to https://github.com/junegunn/vim-plug for further information.

LAZY.NVIM

In Neovim (Lua configuration):

Refer to https://github.com/folke/lazy.nvim for further information.

As a Native Vim Package

Users of Vim 8 and greater may leverage Vim's native |packages| system.

1. Create a new directory: `$ mkdir -p ~/.vim/pack/colors/opt`

2. Clone this repository: `$ git clone --depth 1 https://github.com/sainnhe/everforest.git ~/.vim/pack/colors/opt/everforest`

3. Generate help tags: `:helptags ~/.vim/pack/colors/opt/everforest/doc/`

4. Add `packadd! everforest` to your vimrc.

Note: If you install this color scheme to `pack/*/start` instead of

`pack/*/opt`, you still need to add `packadd! everforest` to your vimrc,

as discussed in the following issue:

Manually

Users of Vim 7 and lower may install the colorscheme manually.

1. Clone the repository: `git clone --depth 1 https://github.com/sainnhe/everforest.git`

2. Copy `everforest/autoload/everforest.vim` to `~/.vim/autoload/`.

3. Copy `everforest/colors/everforest.vim` to `~/.vim/colors/`.

4. Copy `everforest/doc/everforest.txt` to `~/.vim/doc/` and

execute `:helptags ~/.vim/doc/` to generate help tags.

5. To install the airline theme, copy

`everforest/autoload/airline/themes/everforest.vim`

to `~/.vim/autoload/airline/themes/`.

https://github.com/vim-airline/vim-airline

6. To install the lightline theme,

copy `everforest/autoload/lightline/colorscheme/everforest.vim`

to `~/.vim/autoload/lightline/colorscheme/`.

https://github.com/itchyny/lightline.vim

7. To install the lualine theme,

copy `everforest/lua/lualine/themes/everforest.lua`

to `~/.config/nvim/lua/lualine/themes/`.

https://github.com/nvim-lualine/lualine.nvim

AUR

There are some packages available for Arch Linux users in AUR:

https://aur.archlinux.org/pkgbase/vim-everforest-git (Vim)

https://aur.archlinux.org/pkgbase/neovim-everforest-git (Neovim)

USAGE *everforest-usage*

Put something like this in your vimrc:

See |everforest-configuration| for more configuration options.

If you want to apply this color scheme temporarily, run this command in

vim(this may cause broken colors):

To enable [airline](https://github.com/vim-airline/vim-airline) color

scheme, put this in your vimrc:

To apply it without reloading:

To enable [lightline](https://github.com/itchyny/lightline.vim) color

scheme, put this in your vimrc:

To apply it without reloading:

To enable [lualine](https://github.com/nvim-lualine/lualine.nvim) color

scheme, put this in your init.lua:

To apply it without reloading:

CONFIGURATION *everforest-configuration*

Note: the configuration options should be placed before `colorscheme everforest`

E.g.

*g:everforest_background*

The background contrast used in this color scheme.

Type: |String|

Available values: `'hard'`, `'medium'`, `'soft'`

Default value: `'medium'`

*g:everforest_enable_italic*

To enable italic in this color scheme, set this option to `1`.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

Note: This option is designed to use with fonts that support cursive italics.

See |everforest-faq| for more information.

*g:everforest_disable_italic_comment*

By default, italic is enabled in `Comment`. To disable italic in `Comment`, set

this option to `1`.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

*g:everforest_cursor*

Customize the cursor color, only works in GUI clients.

Type: |String|

Available values: `'auto'`, `'red'`, `'orange'`, `'yellow'`, `'green'`,

`'aqua'`, `'blue'`, `'purple'`

Default value: `'auto'`

*g:everforest_transparent_background*

To use transparent background, set this option to `1`.

If you want more ui components to be transparent (for example, status line

background), set this option to `2`.

Type: |Number|

Available values: `0`, `1`, `2`

Default value: `0`

*g:everforest_dim_inactive_windows*

Dim inactive windows. Only works in Neovim currently.

When this option is used in conjunction with |g:everforest_show_eob| set to 0,

the end of the buffer will only be hidden inside the active window. Inside

inactive windows, the end of buffer filler characters will be visible in

dimmed symbols. This is due to the way Vim and Neovim handle |hl-EndOfBuffer|.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

*g:everforest_sign_column_background*

By default, the color of sign column background is the same as normal text

background, but you can use a grey background by setting this option to `'grey'`.

Type: |String|

Available values: `'none'`, `'grey'`

Default value: `'none'`

*g:everforest_spell_foreground*

By default, this color scheme won't color the foreground of |spell|, instead

colored under curls will be used. If you also want to color the foreground,

set this option to `'colored'`.

Type: |String|

Available values: `'none'`, `'colored'`

Default value: `'none'`

*g:everforest_ui_contrast*

The contrast of line numbers, indent lines, etc.

Type: |String|

Available values: `'low'`, `'high'`

Default value: `'low'`

*g:everforest_show_eob*

Whether to show |hl-EndOfBuffer|.

Type: |Number|

Available values: `1`, `0`

Default value: `1`

*g:everforest_float_style*

Style used to make floating windows stand out from other windows. `'bright'`

makes the background of these windows lighter than |hl-Normal|, whereas

`'dim'` makes it darker.

Floating windows include for instance diagnostic pop-ups, scrollable

documentation windows from completion engines, overlay windows from

installers, etc.

Type: |String|

Available values: `'bright'`, `'dim'`

Default value: `'bright'`

*g:everforest_diagnostic_text_highlight*

Some plugins support highlighting error/warning/info/hint texts, by default

these texts are only underlined, but you can use this option to also highlight

the background of them.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

Currently, the following plugins are supported:

- neovim's built-in language server client

- https://github.com/neoclide/coc.nvim

- https://github.com/prabirshrestha/vim-lsp

- https://github.com/ycm-core/YouCompleteMe

- https://github.com/dense-analysis/ale

- https://github.com/neomake/neomake

- https://github.com/vim-syntastic/syntastic

*g:everforest_diagnostic_line_highlight*

Some plugins support highlighting error/warning/info/hint lines, but this

feature is disabled by default in this color scheme. To enable this feature,

set this option to `1`.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

Currently, the following plugins are supported:

- https://github.com/neoclide/coc.nvim

- https://github.com/ycm-core/YouCompleteMe

- https://github.com/dense-analysis/ale

- https://github.com/vim-syntastic/syntastic

*g:everforest_diagnostic_virtual_text*

Some plugins can use the virtual text feature of Neovim to display

error/warning/info/hint information. You can use this option to adjust the

way these virtual texts are highlighted.

Type: |String|

Available values: `'grey'`, `'colored'`, `'highlighted'`

Default value: `'grey'`

Currently, the following plugins are supported:

- Neovim's built-in language server client

- https://github.com/neoclide/coc.nvim

- https://github.com/prabirshrestha/vim-lsp

- https://github.com/dense-analysis/ale

- https://github.com/neomake/neomake

- https://github.com/ycm-core/YouCompleteMe

*g:everforest_current_word*

Some plugins can highlight the word under current cursor, you can use this

option to control their behavior.

Type: |String|

Available values: `'grey background'`, `'bold'`, `'underline'`, `'italic'`

Default value: `'grey background'` when not in transparent mode, `'bold'`

when in transparent mode.

Currently, the following plugins are supported:

- https://github.com/neoclide/coc-highlight

- https://github.com/dominikduda/vim_current_word

- https://github.com/RRethy/vim-illuminate

- https://github.com/itchyny/vim-cursorword

- https://github.com/prabirshrestha/vim-lsp

*g:everforest_inlay_hints_background*

Inlay hints are special markers that are displayed inline with the code to

provide you with additional information. You can use this option to customize

the background color of inlay hints.

Type: |String|

Available values: `'none'`, `'dimmed'`

Default value: `'none'`

Currently, the following LSP clients are supported:

- Neovim's built-in language server client

- https://github.com/neoclide/coc.nvim

- https://github.com/prabirshrestha/vim-lsp

- https://github.com/ycm-core/YouCompleteMe

*g:everforest_disable_terminal_colors*

Setting this option to `1` will disable terminal colors provided by this color

scheme so you can remain terminal colors the same when using |:terminal| in

vim and outside of vim.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

*g:everforest_lightline_disable_bold*

By default, bold is enabled in lightline color scheme. To disable bold in

lightline color scheme, set this option to `1`.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

Note: this configuration option doesn't need to be placed before `colorscheme everforest`

*g:everforest_better_performance*

The loading time of this color scheme is very long because too many file types

and plugins are optimized. This feature allows you to load part of the code on

demand by placing them in the `after/syntax` directory.

Enabling this option will reduce loading time by approximately 50%.

Type: |Number|

Available values: `0`, `1`

Default value: `0`

*g:everforest_colors_override*

Override color palette. The available keys can be found in

`/path/to/everforest/autoload/everforest.vim`.

E.g.

Type: |Dictionary|

Default value: `{}`

FAQ *everforest-faq*

1. This color scheme is mainly designed for true colors, `set termguicolors`

is required. Check output of `vim --version`, maybe your Vim doesn't support

`termguicolors`, such as the Vim version that comes with macOS.

2. Maybe your terminal emulator doesn't support true colors, you can test it

using [this script](https://unix.stackexchange.com/questions/404414/print-true-color-24-bit-test-pattern).

3. If you are running vim in tmux, you need to override default true colors of

tmux, as tmux cannot display true colors properly:

[#1246 How to use true colors in vim under tmux?](https://github.com/tmux/tmux/issues/1246)

You should place them before `colorscheme everforest` .

You'll need to add `packadd! everforest` before applying this color scheme.

Check [sainnhe/gruvbox-material#60](https://github.com/sainnhe/gruvbox-material/issues/60)

1. Install a font that supports cursive italics, for example https://aka.sainnhe.dev/fonts

2. Enable italic keywords in this color scheme: `let g:everforest_enable_italic = 1`

3. (Optional) Disable italic comment: `let g:everforest_disable_italic_comment = 1`

Some terminal emulators don't support italics, which may cause the comment

color looks weird. See https://github.com/sainnhe/gruvbox-material/issues/5#issuecomment-729586348

A temporary solution is to disable italic comments via

|g:everforest_disable_italic_comment|.

If you are using tmux, you may also need to override default true colors of

tmux: https://github.com/tmux/tmux/issues/1246

Or in Neovim (Lua configuration):

Note: Make sure to define the `augroup` before calling `colorscheme`.

See this post: https://aka.sainnhe.dev/statusline

See this post: https://aka.sainnhe.dev/fonts

vim:tw=78:nosta:noet:ts=8:sts=0:ft=help:et:sw=4:fen:fdm=marker:fmr={{{,}}}: