README.md

vim-colors-github

A Vim colorscheme based on Github's syntax highlighting as of 2018.

I wasn't happy with endel/vim-github-colorscheme, as it was out of date.

It degrades gracefully in non-gui mode (ie ctermbg/ctermfg/256colors).

It supports the following plugins: airline, lightline, fzf, GitGutter, NERDTree, Startify, sneak, and :terminal.

Extra tuning has been done for the following languages: Vim script, Markdown, Pandoc Markdown (vim-pandoc-syntax) Diff, C, Rust, Go (fatih/vim-go), Haskell (neovimhaskell/haskell-vim), Ruby, Python, HTML, XML, TOML, YAML, Clojure, Typescript, (leafgarland/vim-typescript), JSX/TSX (MaxMEllon/vim-jsx-pretty),.

Install

Install with your favourite plugin manager. For vim-plug:

Plug 'cormacrelf/vim-colors-github'

Then set your colorscheme to 'github':

" in your .vimrc or init.vim
colorscheme github

" if you use airline / lightline
let g:airline_theme = "github"
let g:lightline = { 'colorscheme': 'github' }

Options

Place before the colorscheme github:

" use a slightly darker background, like GitHub inline code blocks
let g:github_colors_soft = 1

" use the dark theme
set background=dark

" more blocky diff markers in signcolumn (e.g. GitGutter)
let g:github_colors_block_diffmark = 0

:help github_colors.txt

How to toggle background and also refresh the Lightline theme?

There is a built-in background toggler that does this. Make a mapping for it like so:

call github_colors#togglebg_map('<f5>')

Screenshots

Dark

Light

Soft

License

Distributed under the same terms as Vim itself. See :help license.