/github-nvim-theme

Github theme for Neovim, kitty, iTerm, Konsole, tmux and Alacritty written in Lua

Primary LanguageLuaMIT LicenseMIT

github-nvim-theme

Status

Linting Twitter

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
  • dynamic 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

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

❗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"}
})

Lualine Support

To enable the github theme for Lualine, simply specify it in your lualine settings:

⚠️ Set lualine configuration before github-theme. otherwise, the hide_inactive_statusline option won't work.

packer

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
}

init.vim

lua << EOF
require('lualine').setup {
  options = {
    theme = 'github',
    -- ... your lualine config
  }
}
EOF

init.lua

require('lualine').setup {
  options = {
    theme = 'github',
    -- ... your lualine config
  }
}

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

📺 Screenshot

Theme Styles

Dark

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

github_dark

Dark Default

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

github_dark_default

Dimmed

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

github_dimmed

Light

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

github_light

Light Default

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

github_light_default

Syntax Styles

Default

github_default_syntax

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
})

github_normal_syntax

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
})

github_italic_syntax

Minimal config

" VimScript
let g:github_dark_sidebar = 0
-- Lua
require("github-theme").setup({
  dark_sidebar = false,
  -- other config
})

github_minimal

Telescope

github_telescope

|| || ||