vim-airline-themes/README.md

3.3 KiB

vim-airline-themes Build Status reviewdog

This is the official theme repository for vim-airline

Installation

This plugin follows the standard runtime path structure, and as such it can be installed with a variety of plugin managers:

Plugin Manager Install with...
Pathogen git clone https://github.com/vim-airline/vim-airline-themes ~/.vim/bundle/vim-airline-themes
Remember to run :Helptags to generate help tags
NeoBundle NeoBundle 'vim-airline/vim-airline-themes'
Vundle Plugin 'vim-airline/vim-airline-themes'
Plug Plug 'vim-airline/vim-airline-themes'
VAM call vam#ActivateAddons([ 'vim-airline-themes' ])
Dein call dein#add('vim-airline/vim-airline-themes')
minpac call minpac#add('vim-airline/vim-airline-themes')
pack feature (native Vim 8 package feature) git clone https://github.com/vim-airline/vim-airline-themes ~/.vim/pack/dist/start/vim-airline-themes
Remember to run :helptags ~/.vim/pack/dist/start/vim-airline-themes/doc to generate help tags
manual copy all of the files into your ~/.vim directory

Using a Theme

Once installed, use :AirlineTheme <theme> to set the theme, e.g. :AirlineTheme simple

To set in .vimrc, use let g:airline_theme='<theme>', e.g. let g:airline_theme='simple'

Note: The command :AirlineTheme is only available, if you have also cloned and installed the main vim-airline repository.

Contribution Guidelines

New themes

  • Pull requests for new themes are welcome. Please be sure to include a screenshot. You can paste an image into issue #1, and then editing the post to reveal the uploaded image URL. Please don't forgot to update the documentation.

Modifications to existing themes

  • Themes are subjective, so if you are going to make modifications to an existing theme, please expose a configurable variable to allow users to choose how the theme will react.

Screenshots

Screenshots are in the process of being migrated here. In the meantime you can find screenshots in the existing repository's Wiki.

Maintenance

If you are interested in becoming the official maintainer of this project, please contact @bling, @chrisbra, or @mhartington.

License

MIT License. Copyright (c) 2013-2021 Bailey Ling & Contributors.