Skip to content

Commit

Permalink
Update README to conform with plugin documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@thiagoalessio
thiagoalessio committed Apr 17, 2018
1 parent 894a0ea commit 370f882
Showing 1 changed file with 75 additions and 189 deletions.
264 changes: 75 additions & 189 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ A different approach to code highlighting.
[![License: MIT][license_badge]][mit_license]
[![Tweet][twitter_badge]][tweet_intent]

This plugin highlights your code by indentation level, instead of language syntax.<br/>
It is specially useful when dealing with deeply nested code, callback hells, etc.
This plugin highlights code by indentation level instead of language syntax.
<br/>
It is specially useful when dealing with deeply nested code or callback hells.

## Screenshot

![Rainbow Levels Screenshot](https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/screenshot.png)

> <https://github.com/jquery/jquery/blob/e84d3bc02eddeb0e0ca0438952ac560a794ff463/src/data/Data.js>
![Rainbow Levels Screenshot][]

## Usage

Expand All @@ -37,227 +36,119 @@ map <leader>l :RainbowLevelsToggle<cr>
au FileType javascript,python,php,xml,yaml :RainbowLevelsOn
```

In addition to the commands mentioned above, it also exposes a global variable
`g:rainbow_levels` that can be [overridden][] to change the highlight color of
each level.

## Themes

It looks much better if the colors match the current colorscheme, so to save
you some time, here is a list of `g:rainbow_levels` values for some popular
colorschemes.

<img align="right" width="50%" title="Jellybeans Theme" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/theme-jellybeans.png"/>

### [Jellybeans][]

```vim
let g:rainbow_levels = [
\{'ctermfg': 107, 'guifg': '#65c254'},
\{'ctermfg': 110, 'guifg': '#8fbfdc'},
\{'ctermfg': 103, 'guifg': '#8197bf'},
\{'ctermfg': 183, 'guifg': '#c6b6ee'},
\{'ctermfg': 167, 'guifg': '#cf6a4c'},
\{'ctermfg': 215, 'guifg': '#ffb964'},
\{'ctermfg': 188, 'guifg': '#e8e8d3'},
\{'ctermfg': 244, 'guifg': '#888888'}]
```

<br/><br/>

<img align="right" width="50%" title="Zenburn Theme" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/theme-zenburn.png"/>

### [Zenburn][]

```vim
let g:rainbow_levels = [
\{'ctermfg': 108, 'guifg': '#7f9f7f'},
\{'ctermfg': 116, 'guifg': '#8cd0d3'},
\{'ctermfg': 109, 'guifg': '#9fafaf'},
\{'ctermfg': 174, 'guifg': '#cc9393'},
\{'ctermfg': 223, 'guifg': '#ffd7a7'},
\{'ctermfg': 228, 'guifg': '#efef8f'},
\{'ctermfg': 230, 'guifg': '#f0efd0'},
\{'ctermfg': 240, 'guifg': '#5b605e'}]
```
## Customization

<br/><br/>
To customize the levels you just need to define highlight groups whith the
name `RainbowLevelsN`, where `N` is the number of the level.

<img align="right" width="50%" title="Solarized Theme" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/theme-solarized.png"/>
By default this plugin defines `7` highlight groups, simply linking to common
existing highlight groups, in order to respect your colorscheme.

### [Solarized][]
But you are free to define as many levels you wish. Check the examples below
and also the [User-Contributed Themes][user_themes] page for inspiration.

```vim
let g:rainbow_levels = [
\{'ctermfg': 2, 'guifg': '#859900'},
\{'ctermfg': 6, 'guifg': '#2aa198'},
\{'ctermfg': 4, 'guifg': '#268bd2'},
\{'ctermfg': 5, 'guifg': '#6c71c4'},
\{'ctermfg': 1, 'guifg': '#dc322f'},
\{'ctermfg': 3, 'guifg': '#b58900'},
\{'ctermfg': 8, 'guifg': '#839496'},
\{'ctermfg': 7, 'guifg': '#586e75'}]
```
### Examples

<br/><br/>
#### Jellybeans Rainbow

<img align="right" width="50%" title="Dracula Theme" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/theme-dracula.png"/>
<img align="right" width="45%" title="Jellybeans Rainbow" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-jellybeans.png"/>

### [Dracula][]
Using groups defined by [Jellybeans][] colorscheme in a "rainbow" sequence.

```vim
let g:rainbow_levels = [
\{'ctermfg': 84, 'guifg': '#50fa7b'},
\{'ctermfg': 117, 'guifg': '#8be9fd'},
\{'ctermfg': 61, 'guifg': '#6272a4'},
\{'ctermfg': 212, 'guifg': '#ff79c6'},
\{'ctermfg': 203, 'guifg': '#ffb86c'},
\{'ctermfg': 228, 'guifg': '#f1fa8c'},
\{'ctermfg': 15, 'guifg': '#f8f8f2'},
\{'ctermfg': 231, 'guifg': '#525563'}]
hi! link RainbowLevel0 Constant
hi! link RainbowLevel1 Type
hi! link RainbowLevel2 Function
hi! link RainbowLevel3 String
hi! link RainbowLevel4 PreProc
hi! link RainbowLevel5 Statement
hi! link RainbowLevel6 Identifier
hi! link RainbowLevel7 Normal
hi! link RainbowLevel8 Comment
```

<br/><br/>

<img align="right" width="50%" title="Monokai Theme" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/theme-monokai.png"/>

### [Monokai][]

```vim
let g:rainbow_levels = [
\{'ctermfg': 2, 'guifg': '#a6e22e'},
\{'ctermfg': 6, 'guifg': '#66d9ef'},
\{'ctermfg': 4, 'guifg': '#ae81ff'},
\{'ctermfg': 5, 'guifg': '#f92672'},
\{'ctermfg': 1, 'guifg': '#fd971f'},
\{'ctermfg': 3, 'guifg': '#f4bf75'},
\{'ctermfg': 7, 'guifg': '#f8f8f2'},
\{'ctermfg': 0, 'guifg': '#75715e'}]
```
<br/>

<br/><br/>
#### Background Only

<img align="right" width="50%" title="Birds of Paradise Theme" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/theme-birds-of-paradise.png"/>
<img align="right" width="45%" title="Background Only" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-background.png"/>

### [Birds of Paradise][]
Want to keep syntax highlight? No problem! You can change only the background
colors instead.

```vim
let g:rainbow_levels = [
\{'ctermfg': 185, 'guifg': '#d9d762'},
\{'ctermfg': 109, 'guifg': '#86b4bb'},
\{'ctermfg': 67, 'guifg': '#6c99bb'},
\{'ctermfg': 98, 'guifg': '#8856d2'},
\{'ctermfg': 203, 'guifg': '#ef5d32'},
\{'ctermfg': 215, 'guifg': '#efac32'},
\{'ctermfg': 188, 'guifg': '#e6e1c4'},
\{'ctermfg': 59, 'guifg': '#6b4e32'}]
hi! RainbowLevel0 ctermbg=240 guibg=#585858
hi! RainbowLevel1 ctermbg=239 guibg=#4e4e4e
hi! RainbowLevel2 ctermbg=238 guibg=#444444
hi! RainbowLevel3 ctermbg=237 guibg=#3a3a3a
hi! RainbowLevel4 ctermbg=236 guibg=#303030
hi! RainbowLevel5 ctermbg=235 guibg=#262626
hi! RainbowLevel6 ctermbg=234 guibg=#1c1c1c
hi! RainbowLevel7 ctermbg=233 guibg=#121212
hi! RainbowLevel8 ctermbg=232 guibg=#080808
```

<br/>

### Check the [User-Contributed Themes][user_themes] Wiki Page for more ;D

<br/>

## Customization

It doesn't need to look like a rainbow, you can go **crazy** on how you want
to have it colored.
#### Cycle colors

~~**Note:** The only limitation at the moment is that you can't repeat colors;
Every entry on `g:rainbow_levels` should be unique.~~ (Fixed by PR #9)
<img align="right" width="45%" title="Cycle colors" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-cycle.png"/>

<img align="right" width="50%" title="Shades of Blue" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-shades-of-blue.png"/>

### Shades of Blue
Using a loop to automate the tedious work of defining all highlight groups.

```vim
let g:rainbow_levels = [
\{'ctermfg': 51, 'guifg': '#00ffff'},
\{'ctermfg': 45, 'guifg': '#00d7ff'},
\{'ctermfg': 39, 'guifg': '#00afff'},
\{'ctermfg': 33, 'guifg': '#0087ff'},
\{'ctermfg': 27, 'guifg': '#005fff'},
\{'ctermfg': 21, 'guifg': '#0000ff'},
\{'ctermfg': 20, 'guifg': '#0000d7'},
\{'ctermfg': 19, 'guifg': '#0000af'},
\{'ctermfg': 18, 'guifg': '#000087'},
\{'ctermfg': 17, 'guifg': '#00005f'}]
for level in range(0, 10, 2)
exe 'hi! RainbowLevel'.level.' guifg=magenta'
exe 'hi! RainbowLevel'.(level+1).' guifg=cyan'
endfor
```

<br/><br/>

## Want to keep syntax highlight?

No problem! You can change just the background colors instead.

<img align="right" width="50%" title="Shades of Gray BG" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-shades-of-gray-bg.png"/>

### Shades of Gray (Background)
<br/><br/><br/><br/>

```vim
let g:rainbow_levels = [
\{'ctermbg': 232, 'guibg': '#080808'},
\{'ctermbg': 233, 'guibg': '#121212'},
\{'ctermbg': 234, 'guibg': '#1c1c1c'},
\{'ctermbg': 235, 'guibg': '#262626'},
\{'ctermbg': 236, 'guibg': '#303030'},
\{'ctermbg': 237, 'guibg': '#3a3a3a'},
\{'ctermbg': 238, 'guibg': '#444444'},
\{'ctermbg': 239, 'guibg': '#4e4e4e'},
\{'ctermbg': 240, 'guibg': '#585858'}]
```

<br/><br/>
#### Level Alert

<img align="right" width="50%" title="Rainbow BG" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-rainbow-bg.png"/>
<img align="right" width="45%" title="Level Alert" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-alert.png"/>

### Rainbows (Background)
Nothing shows up until a certain threshold, warning you that the code is going
too deep.

```vim
let g:rainbow_levels = [
\{'ctermbg': 222, 'guibg': '#ffd787'},
\{'ctermbg': 223, 'guibg': '#ffd7af'},
\{'ctermbg': 230, 'guibg': '#ffffd7'},
\{'ctermbg': 193, 'guibg': '#d7ffaf'},
\{'ctermbg': 195, 'guibg': '#d7ffff'},
\{'ctermbg': 189, 'guibg': '#d7d7ff'},
\{'ctermbg': 225, 'guibg': '#ffd7ff'},
\{'ctermbg': 224, 'guibg': '#ffd7d7'}]
hi! RainbowLevel0 guibg=none guifg=none
hi! RainbowLevel2 guibg=none guifg=none
hi! RainbowLevel3 guibg=none guifg=none
hi! RainbowLevel4 guibg=none guifg=none
hi! link RainbowLevel5 WarningMsg
for level in range(6, 10)
exe 'hi! link RainbowLevel'.level.' ErrorMsg'
endfor
```

<br/><br/>
<br/>

<img align="right" width="50%" title="Level Alert" src="https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/example-level-alert.png"/>
## Special Thanks

### Level "Alert"
* [Campbell Vertesi][ohthehugemanatee] and [Victor Schroder][schrodervictor]
for the idea to fade the levels in shades of a single color.

```vim
let g:rainbow_levels = [
\{'ctermbg': 'none'},
\{'ctermbg': 'none'},
\{'ctermbg': 'none'},
\{'ctermbg': 'none'},
\
\{'ctermbg': 3, 'guibg': '#ffc66d'},
\{'ctermbg': 9, 'guibg': '#cc7833'},
\{'ctermbg': 1, 'guibg': '#da4939'},
\{'ctermbg': 160, 'guibg': '#870000'}]
```

<br/><br/>
* [David De Sousa][dedsm] and [Lucas Caton][lucascaton] for the idea of
highlighting only the background color, to keep syntax highlight.

## Special Thanks
* [Derek Shoemaker][shoemakerdr] for creating the very first
[User-Contributed Theme][user_themes], with a different "rainbow" order,
making a beautiful contrast between levels.

* [Campbell Vertesi][ohthehugemanatee] and [Victor Schröder][schrodervictor] for the idea to fade the levels in shades of a single color;
* [David De Sousa][dedsm] and [Lucas Caton][lucascaton] for the idea of highlighting only the background color, to keep syntax highlight;
* [Derek Shoemaker][shoemakerdr] for creating the very first [User-Contributed Theme][user_themes], with a different "rainbow" order, making a beautiful contrast between levels;
* [Ingo Karkat][inkarkat] for identifying and **fixing** several issues present on the initial implementation, refining this plugin and bringing it to the next level;
* [Ingo Karkat][inkarkat] for identifying and **fixing** several issues
present on the initial implementation.

## Where to get help

Join the chat at <https://gitter.im/thiagoalessio/rainbow_levels.vim>

## Bugs

Please report any bugs you may find on the GitHub issue tracker:
<http://github.com/thiagoalessio/rainbow_levels.vim/issues>

## License

rainbow_levels.vim is released under the [MIT License][].
Expand All @@ -274,13 +165,8 @@ rainbow_levels.vim is released under the [MIT License][].
[twitter_badge]: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter
[tweet_intent]: https://twitter.com/intent/tweet?text=rainbow_levels.vim%3A%20A%20different%20approach%20to%20code%20highlighting.&url=https://github.com/thiagoalessio/rainbow_levels.vim&hashtags=vim
[mit_license]: https://opensource.org/licenses/MIT
[Rainbow Levels Screenshot]: https://thiagoalessio.ams3.digitaloceanspaces.com/rainbow_levels/screenshot.png?v=0.6.0
[Jellybeans]: https://github.com/nanotech/jellybeans.vim
[Zenburn]: http://kippura.org/zenburnpage/
[Solarized]: http://ethanschoonover.com/solarized
[Dracula]: https://draculatheme.com/
[Monokai]: http://www.monokai.nl/
[Birds of Paradise]: http://joebergantine.com/
[overridden]: https://github.com/thiagoalessio/rainbow_levels.vim#customization
[user_themes]: https://github.com/thiagoalessio/rainbow_levels.vim/wiki/User-Contributed-Themes
[ohthehugemanatee]: https://github.com/ohthehugemanatee
[schrodervictor]: https://github.com/schrodervictor
Expand Down

0 comments on commit 370f882

Please sign in to comment.