vipul-sharma20 / kanagawa.nvim

NeoVim dark colorscheme inspired by the colors of the famous painting by Katsushika Hokusai.

🌊 KANAGAWA.nvim 🌊

NeoVim dark colorscheme inspired by the colors of the famous painting by Katsushika Hokusai.

Installation

Download with your favorite package manager.

use "rebelot/kanagawa.nvim"

Requirements

• neovim >= 0.6
• truecolor terminal support
• undercurl terminal support (optional)

Usage

As simple as writing (pasting)

colorscheme kanagawa

vim.cmd("colorscheme kanagawa")

Plugin Support

• Nvim cmp
• TreeSitter
• LSP Diagnostics
• Git Signs
• Telescope
• NvimTree
• Indent Blankline
• Dashboard
• Lualine

And many others should "just work"!

Configuration

There is no need to call setup if you are ok with the defaults.

-- Default options:
require('kanagawa').setup({
    undercurl = true,           -- enable undercurls
    commentStyle = "italic",
    functionStyle = "NONE",
    keywordStyle = "italic",
    statementStyle = "bold",
    typeStyle = "NONE",
    variablebuiltinStyle = "italic",
    specialReturn = true,       -- special highlight for the return keyword
    specialException = true,    -- special highlight for exception handling keywords 
    transparent = false,        -- do not set background color
    colors = {},
    overrides = {},
})

-- setup must be called before loading
vim.cmd("colorscheme kanagawa")

Customize highlight groups and colors

You can change the colors of existing hl-groups as well as creating new ones. Supported keywords: fg, bg, style, guisp, link.

You can define your own colors or use the theme colors (see example below). All the palette colors can be found here.

Example:

local default_colors = require("kanagawa").colors

local overrides = {
    -- create a new hl-group using default palette colors and/or new ones
    MyHlGroup1 = { fg = default_colors.waveRed, bg = "#AAAAAA", style="underline,bold", guisp="blue" },

    -- override existing hl-groups, the new keywords are merged with existing ones
    VertSplit  = { fg = default_colors.bg_dark, bg = "NONE" },
    TSError    = { link = "Error" },
    TSKeywordOperator = { style = 'bold'}
}

-- this will affect all the hl-groups where the redefined colors are used
local colors = {
    sumiInk1 = "black",
    fujiWhite = "#FFFFFF"
}

require'kanagawa'.setup({ overrides = overrides, colors = colors })
vim.cmd("colorscheme kanagawa")

Extras

• kitty
• iTerm
• alacritty
• 🎉 Bonus! You win a tiny python script🐍 to extract color palettes 🎨 from images! 🥳

Acknowledgements

• Tokyonight
• Gruvbox
• Affinity Designer

Related projects

• kanagawa.vim - unaffiliated vimscript port of kanagawa.nvim