148 lines
6.2 KiB
Markdown
148 lines
6.2 KiB
Markdown
# vim-code-dark
|
|
`vim-code-dark` is a dark **color scheme for [Vim](http://www.vim.org/)** heavily inspired by the look of the Dark+ scheme of [Visual Studio Code](https://code.visualstudio.com/). While many of the colors are same, there are additional colors for specific usage or reserved for future use. The scheme also defines specific GUI colors (e.g. popup menu) and fully supports [`vim-airline`](https://github.com/vim-airline/vim-airline).
|
|
|
|
**:exclamation: To install and enable this colorscheme, [read installation instructions](#installation).**
|
|
|
|
*This colorscheme does also support 256 and 8/16 color terminals. See [installation instructions](#installation) step 3.*
|
|
|
|
## Screenshots
|
|
|
|
### gVim / modern terminals
|
|
|
|
|
|
|
|
*Code samples [1](http://sandbox.mc.edu/~bennet/ruby/code/), [2](https://tmtheme-editor.herokuapp.com/), [`nerdtree`](https://github.com/scrooloose/nerdtree)*
|
|
|
|
### Terminals with limited color support
|
|
|
|
#### Fixed 256 colors
|
|
|
|
|
|
#### Fixed 8/16 colors
|
|
|
|
|
|
## Installation
|
|
|
|
### 1) Download
|
|
|
|
Simply as any other Vim plugins: download manually or follow the standard procedure of your plugin manager:
|
|
* [Vundle](https://github.com/gmarik/vundle)
|
|
```vim
|
|
Plugin 'tomasiser/vim-code-dark'
|
|
```
|
|
* [vim-plug](https://github.com/junegunn/vim-plug)
|
|
```vim
|
|
Plug 'tomasiser/vim-code-dark'
|
|
```
|
|
* [builtin package manager](https://vimhelp.org/repeat.txt.html#packages)
|
|
```bash
|
|
# Regular Vim
|
|
mkdir -p ~/.vim/pack/themes/start
|
|
cd ~/.vim/pack/themes/start
|
|
git clone https://github.com/tomasiser/vim-code-dark
|
|
|
|
# Neovim
|
|
mkdir -p ~/.local/share/nvim/site/pack/themes/start
|
|
cd ~/.local/share/nvim/site/pack/themes/start
|
|
git clone https://github.com/tomasiser/vim-code-dark
|
|
```
|
|
|
|
### 2) Enable in `.vimrc`
|
|
|
|
Add the following line to your `.vimrc`:
|
|
|
|
```vim
|
|
colorscheme codedark
|
|
```
|
|
|
|
### 3) Terminal support
|
|
|
|
#### 3.1) If you use gVim / a modern terminal
|
|
:+1: The colorscheme will work out of the box. No need to setup anything else!
|
|
|
|
#### 3.2) If the colors seem to be wrong
|
|
If your terminal supports 256 colors (see [this script](http://www.robmeerman.co.uk/unix/256colours) if you want to test your terminal), you **may need to set `t_Co` to 256** and [possibly also reset the `t_ut` value](http://vi.stackexchange.com/questions/238/tmux-is-changing-part-of-the-background-in-vim) in your `.vimrc` before setting the colorscheme:
|
|
```vim
|
|
set t_Co=256
|
|
set t_ut=
|
|
colorscheme codedark
|
|
```
|
|
|
|
(Additionally, if you don't want to or cannot use `t_Co`, you can `let g:codedark_term256=1`.)
|
|
|
|
#### 3.3) If your terminal only supports 8/16 colors
|
|
|
|
:exclamation: Before following those steps, first try step 3.2) - maybe your terminal does support 256 colors!
|
|
|
|
If your terminal does not support 256 colors, you may want to change your terminal colors:
|
|
|
|
##### 3.3.1) Some Unix terminals
|
|
Clone [`base16-shell`](https://github.com/chriskempson/base16-shell/) into `~/.config/base16-shell`:
|
|
|
|
```bash
|
|
git clone https://github.com/chriskempson/base16-shell.git ~/.config/base16-shell
|
|
```
|
|
|
|
Then copy a script from this (`vim-code-dark`) repository (`base16/templates/shell/scripts/base16-codedark.sh`) into `~/.config/base16-shell/scripts`.
|
|
|
|
Following the instructions from [`base16-shell`](https://github.com/chriskempson/base16-shell/), you should now modify your `~/.bashrc` or `~/.zshrc` (depending on your shell) and insert the following lines:
|
|
|
|
```bash
|
|
BASE16_SHELL=$HOME/.config/base16-shell/
|
|
[ -n "$PS1" ] && [ -s $BASE16_SHELL/profile_helper.sh ] && eval "$($BASE16_SHELL/profile_helper.sh)"
|
|
```
|
|
|
|
Now start a new shell and type the following command: `base16_codedark`.
|
|
|
|
You should now be able to use Vim with your new colorscheme.
|
|
|
|
##### 3.3.2) PuTTY
|
|
PuTTY should actually support 256 colors, try following [steps on StackOverflow](http://superuser.com/questions/436910/emulate-256-colors-in-putty-terminal). If it does not work, run `base16/templates/putty/putty/base16-codedark.reg` to modify your registry, then run PuTTY and load `codedark` in the session list. This will modify your PuTTY terminal colors.
|
|
|
|
## CUSTOMIZATION
|
|
|
|
**:exclamation: To enable any of the following customizations, put the specific lines before setting the colorscheme**
|
|
```vim
|
|
" If you don't like many colors and prefer the conservative style of the standard Visual Studio
|
|
let g:codedark_conservative=1
|
|
" Activates italicized comments
|
|
let g:codedark_italics=1
|
|
" Make the background transparent (make sure your terminal supports italics)
|
|
let g:codedark_transparent=1
|
|
" If you have vim-airline, you can also enable the provided theme
|
|
let g:airline_theme = 'codedark'
|
|
|
|
colorscheme codedark
|
|
```
|
|
|
|
## FAQ
|
|
|
|
### The background color in my terminal is wrong when there is no text!
|
|
Try resetting the `t_ut` value in your `.vimrc` as [described here](http://vi.stackexchange.com/questions/238/tmux-is-changing-part-of-the-background-in-vim):
|
|
```vim
|
|
set t_Co=256
|
|
set t_ut=
|
|
colorscheme codedark
|
|
```
|
|
|
|
### Something is broken but I know how to fix it!
|
|
Pull requests are welcome! Feel free to send one with an explanation!
|
|
|
|
### Why does file syntax not look exactly like in Visual Studio Code?
|
|
Because Vim uses different syntax rules. This is just a colorscheme for vim, not a syntax definition.
|
|
|
|
### My favourite language has wrong / bad / awful colors!
|
|
There are a lot of syntax definitions with different highlight groups. Feel free to send a pull request with additional highlight groups!
|
|
|
|
### What setup can I see on the first screenshots?
|
|
Screenshots come from gVim on Windows with the following font options and [`vim-airline`](https://github.com/vim-airline/vim-airline) enabled.
|
|
|
|
```vim
|
|
set enc=utf-8
|
|
set guifont=Powerline_Consolas:h11
|
|
set renderoptions=type:directx,gamma:1.5,contrast:0.5,geom:1,renmode:5,taamode:1,level:0.5
|
|
```
|
|
|
|
## Color Palette
|
|
|
|
|