Files
vim-monokai-tasty/README.md
2020-10-24 20:44:45 +11:00

130 lines
4.9 KiB
Markdown

# vim-monokai-tasty
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-blueviolet.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
![Last commit](https://img.shields.io/github/last-commit/patstockwell/vim-monokai-tasty?color=blue)
[![Donate with Bitcoin](https://en.cryptobadges.io/badge/small/1AddzniWjahrTidwC1QhBkcX7RYwn2JVoq)](https://en.cryptobadges.io/donate/1AddzniWjahrTidwC1QhBkcX7RYwn2JVoq)
Monokai forever! :tada: Inspired by Sublime Text's interpretation of monokai, this colour is both gui- and cterm-supported.
It works for all languages, and is particularly good for JavaScript and TypeScript development :heart:
Unlike other monokai implementations, `vim-monokai-tasty` targets named syntax groups from a variety of modern syntax group plugins (listed below). _*74% tastier than competitors_ :taco:
*according to me
![](./images/example_main.png)
## :electric_plug: Installation
I recommend using [Plug](https://github.com/junegunn/vim-plug).
Add the following to your `.vimrc` and run `PlugInstall`
```vim
Plug 'patstockwell/vim-monokai-tasty'
```
If you use _Vundle_:
```vim
Plugin 'patstockwell/vim-monokai-tasty'
```
## :wolf: Use
Add the following to your `.vimrc` (after the Plug declaration):
```vim
colorscheme vim-monokai-tasty
```
If you use a terminal that supports italic text, add (before the colorscheme declaration):
```vim
let g:vim_monokai_tasty_italic = 1
colorscheme vim-monokai-tasty
```
To use the included [lightline.vim](https://github.com/itchyny/lightline.vim) theme:
```vim
let g:lightline = {
\ 'colorscheme': 'monokai_tasty',
\ }
```
To use the included [vim-airline](https://github.com/vim-airline/vim-airline) theme:
```vim
let g:airline_theme='monokai_tasty'
```
## :books: Additional plugins with targeted syntax groups
For JavaScript, TypeScript, and React development, _monokai-tasty_ supports definitions from all these plugins.
Add some of these for an even better look and feel:
```vim
Plug 'HerringtonDarkholme/yats.vim'
Plug 'pangloss/vim-javascript'
Plug 'MaxMEllon/vim-jsx-pretty'
Plug 'styled-components/vim-styled-components'
Plug 'elzr/vim-json'
Plug 'jparise/vim-graphql'
```
## :crystal_ball: Extras
- If you use [iterm2](https://iterm2.com/) (you should), there is an included _monokai.itermcolors_ file.
- If you use GnuCoreutils there is a _dircolors_ file (compliments the iterm colours)
## :tv: Screen shots
![](./images/example_javascript.png)
![](./images/example_vim_and_markdown.png)
![](./images/example_ruby.png)
## :star: Example `.vimrc`
```vim
" put Plug declaration first
call plug#begin('~/.vim/plugged')
Plug 'patstockwell/vim-monokai-tasty'
Plug 'HerringtonDarkholme/yats.vim'
Plug 'pangloss/vim-javascript'
Plug 'MaxMEllon/vim-jsx-pretty'
Plug 'elzr/vim-json'
Plug 'styled-components/vim-styled-components'
Plug 'itchyny/lightline.vim'
Plug 'vim-airline/vim-airline'
call plug#end()
let g:vim_monokai_tasty_italic = 1 " allow italics, set this before the colorscheme
colorscheme vim-monokai-tasty " set the colorscheme
" Optional themes for airline/lightline
let g:airline_theme='monokai_tasty' " airline theme
let g:lightline = { 'colorscheme': 'monokai_tasty' } " lightline theme
" If you don't like a particular colour choice from `vim-monokai-tasty`, you can
" override it here. For example, to change the colour of the search hightlight:
hi Search guifg=#bada55 guibg=#000000 gui=bold ctermfg=green ctermbg=black cterm=bold
" If you don't know what the name of a particular hightlight is, you can use
" `What`. It will print out the syntax group that the cursor is currently above.
" from https://www.reddit.com/r/vim/comments/6z4aau/how_to_stop_vim_from_autohighlighting_italics_in/
command! What echo synIDattr(synID(line('.'), col('.'), 1), 'name')
```
## :art: Colour palette
| Colour name |Colour Code | Colour
|------------------|------------|------------------------------------------------------------
| Yellow | `#ffff87` |![#ffff87](https://placehold.it/100x40/ffff87/111111?text=+)
| Purple | `#af87ff` |![#af87ff](https://placehold.it/100x40/af87ff/000000?text=+)
| Light Green | `#A4E400` |![#A4E400](https://placehold.it/100x40/A4E400/000000?text=+)
| Light Blue | `#62D8F1` |![#62D8F1](https://placehold.it/100x40/62D8F1/000000?text=+)
| Magenta | `#FC1A70` |![#FC1A70](https://placehold.it/100x40/FC1A70/000000?text=+)
| Orange | `#FF9700` |![#FF9700](https://placehold.it/100x40/FF9700/000000?text=+)
## :building_construction: Support
If you like `vim-monokai-tasty` or find this plugin useful, you can support me by donating bitcoin to the following address.
[![Donate with Bitcoin](https://en.cryptobadges.io/badge/small/1AddzniWjahrTidwC1QhBkcX7RYwn2JVoq)](https://en.cryptobadges.io/donate/1AddzniWjahrTidwC1QhBkcX7RYwn2JVoq)
![](qr-code.png)