mirror of
https://github.com/patstockwell/vim-monokai-tasty.git
synced 2025-11-13 12:23:49 -05:00
Update README
This commit is contained in:
64
README.md
64
README.md
@@ -1,35 +1,41 @@
|
|||||||
# vim-monokai-tasty
|
# `vim-monokai-tasty`
|
||||||
|
|
||||||
[](http://makeapullrequest.com)
|
[](http://makeapullrequest.com)
|
||||||
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
|
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
|
||||||

|

|
||||||
[](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.
|
Monokai forever! 🎉 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:
|
It works for all languages, and is particularly good for JavaScript and TypeScript development ❤️
|
||||||
|
|
||||||
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:
|
Unlike other monokai implementations, `vim-monokai-tasty` targets named syntax groups from a variety of plugins (listed below). <sup>1</sup>_This colorscheme is 74% tastier than competitors_ 🌮
|
||||||
|
|
||||||
*according to me
|
<sup>1</sup>according to me
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## :electric_plug: Installation
|
## 🔌 Installation
|
||||||
|
|
||||||
I recommend using [Plug](https://github.com/junegunn/vim-plug).
|
If you use _pathogen_
|
||||||
|
```bash
|
||||||
Add the following to your `.vimrc` and run `PlugInstall`
|
git clone https://github.com/patstockwell/vim-monokai-tasty.git ~/.vim/bundle/vim-monokai-tasty
|
||||||
|
```
|
||||||
|
|
||||||
|
If you use _vim-plug_, add the following and run `:PlugInstall`
|
||||||
```vim
|
```vim
|
||||||
Plug 'patstockwell/vim-monokai-tasty'
|
Plug 'patstockwell/vim-monokai-tasty'
|
||||||
```
|
```
|
||||||
|
|
||||||
If you use _Vundle_:
|
If you use _Vundle_, add the following and run `:PluginInstall`
|
||||||
```vim
|
```vim
|
||||||
Plugin 'patstockwell/vim-monokai-tasty'
|
Plugin 'patstockwell/vim-monokai-tasty'
|
||||||
```
|
```
|
||||||
|
|
||||||
## :wolf: Use
|
If you use _minpac_, add the following and run `:call minpac#update()`
|
||||||
|
```vim
|
||||||
|
call minpac#add('vim-jp/syntax-vim-ex')
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🐺 Use
|
||||||
|
|
||||||
Add the following to your `.vimrc` (after the Plug declaration):
|
Add the following to your `.vimrc` (after the Plug declaration):
|
||||||
```vim
|
```vim
|
||||||
@@ -42,11 +48,15 @@ let g:vim_monokai_tasty_italic = 1
|
|||||||
colorscheme vim-monokai-tasty
|
colorscheme vim-monokai-tasty
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you want the slightly darker blue [variant of monokai](https://monokai.pro/) called "Machine"
|
||||||
|
```vim
|
||||||
|
let g:vim_monokai_tasty_machine_tint = 1
|
||||||
|
colorscheme vim-monokai-tasty
|
||||||
|
```
|
||||||
|
|
||||||
To use the included [lightline.vim](https://github.com/itchyny/lightline.vim) theme:
|
To use the included [lightline.vim](https://github.com/itchyny/lightline.vim) theme:
|
||||||
```vim
|
```vim
|
||||||
let g:lightline = {
|
let g:lightline = { 'colorscheme': 'monokai_tasty' }
|
||||||
\ 'colorscheme': 'monokai_tasty',
|
|
||||||
\ }
|
|
||||||
```
|
```
|
||||||
|
|
||||||
To use the included [vim-airline](https://github.com/vim-airline/vim-airline) theme:
|
To use the included [vim-airline](https://github.com/vim-airline/vim-airline) theme:
|
||||||
@@ -54,7 +64,7 @@ To use the included [vim-airline](https://github.com/vim-airline/vim-airline) th
|
|||||||
let g:airline_theme='monokai_tasty'
|
let g:airline_theme='monokai_tasty'
|
||||||
```
|
```
|
||||||
|
|
||||||
## :books: Additional plugins with targeted syntax groups
|
## 📚 Additional plugins with targeted syntax groups
|
||||||
For JavaScript, TypeScript, and React development, _monokai-tasty_ supports definitions from all these plugins.
|
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:
|
Add some of these for an even better look and feel:
|
||||||
```vim
|
```vim
|
||||||
@@ -66,18 +76,18 @@ Plug 'elzr/vim-json'
|
|||||||
Plug 'jparise/vim-graphql'
|
Plug 'jparise/vim-graphql'
|
||||||
```
|
```
|
||||||
|
|
||||||
## :crystal_ball: Extras
|
## 🔮 Extras
|
||||||
|
|
||||||
- If you use [iterm2](https://iterm2.com/) (you should), there is an included _monokai.itermcolors_ file.
|
- 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)
|
- If you use GnuCoreutils there is a _dircolors_ file (compliments the iterm colours)
|
||||||
|
|
||||||
## :tv: Screen shots
|
## 📺 Screen shots
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
## :star: Example `.vimrc`
|
## 🌟 Example `.vimrc`
|
||||||
|
|
||||||
```vim
|
```vim
|
||||||
" put Plug declaration first
|
" put Plug declaration first
|
||||||
@@ -93,6 +103,7 @@ Plug 'vim-airline/vim-airline'
|
|||||||
call plug#end()
|
call plug#end()
|
||||||
|
|
||||||
let g:vim_monokai_tasty_italic = 1 " allow italics, set this before the colorscheme
|
let g:vim_monokai_tasty_italic = 1 " allow italics, set this before the colorscheme
|
||||||
|
let g:vim_monokai_tasty_machine_tint = 1 " use `mahcine` colour variant
|
||||||
colorscheme vim-monokai-tasty " set the colorscheme
|
colorscheme vim-monokai-tasty " set the colorscheme
|
||||||
|
|
||||||
" Optional themes for airline/lightline
|
" Optional themes for airline/lightline
|
||||||
@@ -103,14 +114,13 @@ let g:lightline = { 'colorscheme': 'monokai_tasty' } " lightline theme
|
|||||||
" override it here. For example, to change the colour of the search hightlight:
|
" 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
|
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
|
" If you want to 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.
|
" `:What`. It prints 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/
|
" 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')
|
command! What echomsg synIDattr(synID(line('.'), col('.'), 1), 'name')
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## :art: Colour palette
|
## 🎨 Colour palette
|
||||||
|
|
||||||
| Colour name |Colour Code | Colour
|
| Colour name |Colour Code | Colour
|
||||||
|------------------|------------|------------------------------------------------------------
|
|------------------|------------|------------------------------------------------------------
|
||||||
@@ -121,9 +131,9 @@ command! What echo synIDattr(synID(line('.'), col('.'), 1), 'name')
|
|||||||
| Magenta | `#FC1A70` |
|
| Magenta | `#FC1A70` |
|
||||||
| Orange | `#FF9700` |
|
| Orange | `#FF9700` |
|
||||||
|
|
||||||
## :building_construction: Support
|
## 🏗 Support
|
||||||
If you like `vim-monokai-tasty` or find this plugin useful, you can support me by donating bitcoin to the following address.
|
If you like `vim-monokai-tasty` or find this plugin useful, you can support me by donating bitcoin to the following address.
|
||||||
|
|
||||||
[](https://en.cryptobadges.io/donate/1AddzniWjahrTidwC1QhBkcX7RYwn2JVoq)
|
`1AddzniWjahrTidwC1QhBkcX7RYwn2JVoq`
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
Reference in New Issue
Block a user