- 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
- dynamic lualine theme
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.
- ALE
- circles.nvim
- dashboard-nvim
- Git Signs
- Indent Blankline
- LSP Diagnostics
- LSP Trouble
- lspsaga.nvim
- Lualine
- nvim-bufferline.lua
- nvim-cmp
- nvim-compe
- nvim-web-devicons
- Neogit
- NvimTree
- Telescope
- TreeSitter
- vim-gitgutter
- which-key.nvim
- Neovim >= 0.5.0
Install the theme with your preferred package manager:
Plug 'projekt0n/github-nvim-theme'
use "projekt0n/github-nvim-theme"
Enable the colorscheme:
" Vim Script
colorscheme github_*
-- Lua
require('github-theme').setup()
❗configuration needs to be set BEFORE loading the color scheme with
colorscheme github_*
Option | Default | Description |
---|---|---|
theme_style | dark |
Set theme variant (options: dark /dark_default /dimmed /light /light_default ) |
comment_style | italic |
Highlight style for comments (check :help highlight-args for options) |
keyword_style | italic |
Highlight style for keywords (check :help highlight-args for options) |
function_style | NONE |
Highlight style for functions (check :help highlight-args for options) |
variable_style | NONE |
Highlight style for variables and identifiers (check :help highlight-args for options) |
msg_area_style | NONE |
Highlight style for messages and cmdline (check :help highlight-args for options) |
transparent | false |
Enable this to disable setting the background color |
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 and LuaLine. |
sidebars | {} |
Set a darker background on sidebar-like windows. For example: {"qf", "vista_kind", "terminal", "packer"} |
dark_sidebar | true |
Sidebar like windows like NvimTree get a darker background |
dark_float | false |
Float windows like the lsp diagnostics windows get a darker background. |
colors | {} |
You can override specific color groups to use other groups or a hex color |
" Example config in VimScript
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({
functionStyle = "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"}
})
To enable the github
theme for Lualine
, simply specify it in your lualine settings:
⚠️ Setlualine
configuration beforegithub-theme
. otherwise, thehide_inactive_statusline
option won't work.
use {
"hoob3rt/lualine.nvim",
config = function()
require("lualine").setup {
options = {
theme = "github"
-- ... your lualine config
}
}
end
}
use {
"projekt0n/github-nvim-theme",
after = "lualine.nvim",
config = function()
require("github-theme").setup({
theme_style = "dark_default"
-- your github config
})
end
}
lua << EOF
require('lualine').setup {
options = {
theme = 'github',
-- ... your lualine config
}
}
EOF
require('lualine').setup {
options = {
theme = 'github',
-- ... your lualine config
}
}
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
- Font: Ubuntu Mono
- Terminal: kitty
- Icon: circles.nvim
- dotfiles: dotfiles
" VimScript
colorscheme github_dark
-- Lua
require("github-theme").setup({
theme_style = "dark",
-- other config
})
" VimScript
colorscheme github_dark_default
-- Lua
require("github-theme").setup({
theme_style = "dark_default",
-- other config
})
" VimScript
colorscheme github_dimmed
-- Lua
require("github-theme").setup({
theme_style = "dimmed",
-- other config
})
" VimScript
colorscheme github_light
-- Lua
require("github-theme").setup({
theme_style = "light",
-- other config
})
" VimScript
colorscheme github_light_default
-- Lua
require("github-theme").setup({
theme_style = "light_default",
-- other config
})
" 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
})
" 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
})
" VimScript
let g:github_dark_sidebar = 0
-- Lua
require("github-theme").setup({
dark_sidebar = false,
-- other config
})