Status

Features

• supports the latest Neovim 0.5 features like TreeSitter and LSP
• minimal inactive statusline
• vim terminal colors
• darker background for sidebar-like windows
• color configs for kitty, iTerm2, Konsole, tmux and Alacritty
• Most elegant lualine theme

Terminal Themes (Extras)

To generate the configs make extra or :luafile lua/github-theme/extra/init.lua

Extra color configs for kitty, iTerm, Konsole, tmux and Alacritty can be found in extras directory. To use them, refer to their respective documentation.

Plugin Support

• Builtin lsp diagnostics
• ale
• circles.nvim
• coc.nvim
• dashboard-nvim
• gitsigns.nvim
• indent-blankline.nvim
• lsp-trouble.nvim
• lspsaga.nvim
• lualine.nvim
• neogit
• nvim-bufferline.lua
• nvim-cmp
• nvim-compe
• nvim-notify
• nvim-tree.lua
• nvim-treesitter
• nvim-web-devicons
• telescope.nvim
• vim-gitgutter
• which-key.nvim

Requirements

• Neovim >= 0.5.0

Installation

Install the theme with your preferred package manager:

vim-plug

Plug 'projekt0n/github-nvim-theme'

packer

use "projekt0n/github-nvim-theme"

Usage

Enable the colorscheme:

" Vim Script
colorscheme github_*

-- Lua
require('github-theme').setup()

Configuration

Option	Default	Description
colors	{}	You can override specific color groups to use other groups or a hex color
comment_style	italic	Highlight style for comments (check :help highlight-args for options)
dark_float	false	Float windows like the lsp diagnostics windows get a darker background.
dark_sidebar	true	Sidebar like windows like NvimTree get a darker background
function_style	NONE	Highlight style for functions (check :help highlight-args for options)
hide_end_of_buffer	true	Enabling this option, will hide filler lines (~) after the end of the buffer
hide_inactive_statusline	true	Enabling this option, will hide inactive statuslines and replace them with a thin border instead. Should work with the standard StatusLine.
keyword_style	italic	Highlight style for keywords (check :help highlight-args for options)
msg_area_style	NONE	Highlight style for messages and cmdline (check :help highlight-args for options)
overrides	function	Override specific highlight groups. The function accpet colors as argument.
sidebars	{}	Set a darker background on sidebar-like windows. For example: {"qf", "vista_kind", "terminal", "packer"}
theme_style	dark	Set theme variant (options: dark/dark_default/dimmed/light/light_default)
transparent	false	Enable this to disable setting the background color
variable_style	NONE	Highlight style for variables and identifiers (check :help highlight-args for options)

" Example config in VimScript
" NOTE: Configuration needs to be set BEFORE loading the color scheme with `colorscheme` command
let g:github_function_style = "italic"
let g:github_sidebars = ["qf", "vista_kind", "terminal", "packer"]

" Change the "hint" color to the "orange" color, and make the "error" color bright red
let g:github_colors = {
  \ 'hint': 'orange',
  \ 'error': '#ff0000'
\ }

" Load the colorscheme
colorscheme github_dark

-- Example config in Lua
require("github-theme").setup({
  theme_style = "dark",
  function_style = "italic",
  sidebars = {"qf", "vista_kind", "terminal", "packer"},

  -- Change the "hint" color to the "orange" color, and make the "error" color bright red
  colors = {hint = "orange", error = "#ff0000"},

  -- Overwrite the highlight groups
  overrides = function(c)
    return {
      htmlTag = {fg = c.red, bg = "#282c34", sp = c.hint, style = "underline"},
      DiagnosticHint = {link = "LspDiagnosticsDefaultHint"},
      -- this will remove the highlight groups
      TSField = {},
    }
  end
})

Lualine Support

check LUALINE.md

Making undercurls work properly in Tmux

To have undercurls show up and in color, add the following to your Tmux config file:

# Undercurl
set -g default-terminal "${TERM}"
set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm'  # undercurl support
set -as terminal-overrides ',*:Setulc=\E[58::2::%p1%{65536}%/%d::%p1%{256}%/%{255}%&%d::%p1%{255}%&%d%;m'  # underscore colours - needs tmux-3.0

Reference

• primer/github-vscode-theme
• folke/tokyonight.nvim
• monsonjeremy/onedark.nvim

📺 Screenshot

• Font: Ubuntu Mono
• Terminal: kitty
• Icon: circles.nvim
• StatusLine: Default. dotfiles/nvim/.config/nvim/lua/options.lua#L19-L30
• dotfiles: dotfiles

Theme Styles

Dark

" VimScript
colorscheme github_dark

-- Lua
require("github-theme").setup({
  theme_style = "dark",
  -- other config
})

Dark Default

" VimScript
colorscheme github_dark_default

-- Lua
require("github-theme").setup({
  theme_style = "dark_default",
  -- other config
})

Dimmed

" VimScript
colorscheme github_dimmed

-- Lua
require("github-theme").setup({
  theme_style = "dimmed",
  -- other config
})

Light

" VimScript
colorscheme github_light

-- Lua
require("github-theme").setup({
  theme_style = "light",
  -- other config
})

Light Default

" VimScript
colorscheme github_light_default

-- Lua
require("github-theme").setup({
  theme_style = "light_default",
  -- other config
})

Syntax Styles

Default

Normal

" VimScript
let g:github_comment_style = "NONE"
let g:github_keyword_style = "NONE"
let g:github_function_style = "NONE"
let g:github_variable_style = "NONE"

-- Lua
require("github-theme").setup({
  comment_style = "NONE",
  keyword_style = "NONE",
  function_style = "NONE",
  variable_style = "NONE"
  -- other config
})

Italic

" VimScript
let g:github_comment_style = "italic"
let g:github_keyword_style = "italic"
let g:github_function_style = "italic"
let g:github_variable_style = "italic"

-- Lua
require("github-theme").setup({
  comment_style = "italic",
  keyword_style = "italic",
  function_style = "italic",
  variable_style = "italic"
  -- other config
})

Minimal config

" VimScript
let g:github_dark_sidebar = 0

-- Lua
require("github-theme").setup({
  dark_sidebar = false,
  -- other config
})

Telescope

Contributing

Check CONTRIBUTING.md, any suggestions for features and contributions to the continuing code masterelopment can be made via the issue tracker or code contributions via a Fork & Pull requests.