chibuikemohanele / edge

Clean & Elegant Color Scheme for Vim, Zsh and Terminal Emulators

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

๐ƒ๐š๐ซ๐ค ๐‹๐ข๐ ๐ก๐ญ
๐๐ž๐Ÿ๐š๐ฎ๐ฅ๐ญ dark light
๐ง๐ž๐จ๐ง dark light

Installation

Via Plugin Manager

Take vim-plug for example:

Plug 'sainnhe/edge'

For better syntax highlighting support, please install sheerun/vim-polyglot.

Manually

  1. Clone this repository.
  2. Copy /path/to/edge/colors/* to ~/.vim/colors/ .
  3. To install airline theme, copy /path/to/edge/autoload/airline/themes/* to ~/.vim/autoload/airline/themes/ .
  4. To install lightline theme, copy /path/to/edge/autoload/lightline/colorscheme/* to ~/.vim/autoload/lightline/colorscheme/ .

Usage

Vim

Put this in your vimrc:

" important!!
set termguicolors

" for dark version
set background=dark

" for light version
set background=light

" the configuration options should be placed before `colorscheme edge`
let g:edge_style = 'neon'
let g:edge_disable_italic_comment = 1

colorscheme edge

See Configuration for more configuration options.

If you want to apply this color scheme temporarily, run this command in vim(this may cause broken colors):

:colorscheme edge

Airline

To enable airline color scheme, put this in your vimrc:

let g:airline_theme = 'edge'

To apply it without reloading:

:AirlineTheme edge

Lightline

To enable lightline color scheme, put this in your vimrc:

let g:lightline = {}
let g:lightline.colorscheme = 'edge'

" or this line
let g:lightline = {'colorscheme' : 'edge'}

To apply it without reloading:

:let g:lightline.colorscheme = 'edge'
:call lightline#init()
:call lightline#colorscheme()

Configuration

Note: The configuration options should be placed before colorscheme edge .

  • g:edge_style: Customize the style of this color scheme.
    • Available values: 'default', 'neon'
    • Default value: 'default'
  • g:edge_transparent_background: Set to 1 to enable transparent background.
    • Available values: 0, 1
    • Default value: 0
  • g:edge_popup_menu_selection_background: Control the background color of PmenuSel and WildMenu .
    • Available values: 'blue', 'green', 'purple'
    • Default value: 'blue'
  • g:edge_disable_italic_comment: Set to 1 to disable italic in Comment .
    • Available values: 0, 1
    • Default value: 0
  • g:edge_current_word: Some plugins can highlight the word under current cursor(for example neoclide/coc-highlight), you can use this option to control their behavior.
    • Available values: 'bold', 'underline', 'italic', 'grey background'
    • Default value: 'grey background' when not in transparent mode, 'bold' when in transparent mode.
  • g:edge_lightline_disable_bold: Set to 1 to disable bold in lightline theme.
    • Available values: 0, 1
    • Default value: 0

Tmux Status Line

Check this gist.

Zsh

Terminal Emulators

More

FAQ

Q: It doesn't work as expected.

A:

  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.

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

  3. If you are running vim in tmux, you need to override default true colors of tmux, as tmux cannot display true color properly: #1246 How to use true colors in vim under tmux?

  4. There are many highlight group links in syntax files while a color scheme may change them, enabling one color scheme based on another color scheme enabled is very likely to cause colors to break. If any color is broken, you can enable the color scheme in your vimrc instead of after vim startup.

Q: What's your status line configuration?

A: Check this gist.

Q: What's the font used here?

A: Fira Code Nerd Font.

Inspiration

Thanks to

License

MIT && Anti-996

About

Clean & Elegant Color Scheme for Vim, Zsh and Terminal Emulators

License:MIT License


Languages

Language:Vim Script 100.0%