[{"result":{"data":{"id":226,"owner":"rebelot","name":"kanagawa.nvim","type":"github","source":"awesome-neovim","category":"colorscheme","link":"https://github.com/rebelot/kanagawa.nvim","shortDescription":"NeoVim dark colorscheme inspired by the colors of the famous painting by Katsushika Hokusai.","createdAt":"2023-03-22T19:35:21.592Z","lastSyncedAt":"2023-04-12T12:42:11.967Z","stars":2175,"readme":"

🌊 KANAGAWA.nvim 🌊

\n\n

\n \n

\n\n

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

\n\n

$\"Preview\"$

\n\n## Features\n\n- Extensive support for `TreeSitter` syntax highlighting, and _many_ popular plugins\n- Compilation to lua byte code for super fast startup times\n\n## Installation\n\nDownload with your favorite package manager.\n\n```lua\nuse \"rebelot/kanagawa.nvim\"\n```\n\n## Requirements\n\n- neovim latest\n- truecolor terminal support\n- undercurl terminal support (optional)\n\n## Usage\n\nAs simple as writing (pasting)\n\n```vim\ncolorscheme kanagawa\n```\n\n```lua\nvim.cmd(\"colorscheme kanagawa\")\n```\n\n## Configuration\n\nThere is no need to call setup if you are ok with the defaults.\n\n```lua\n-- Default options:\nrequire('kanagawa').setup({\n compile = false, -- enable compiling the colorscheme\n undercurl = true, -- enable undercurls\n commentStyle = { italic = true },\n functionStyle = {},\n keywordStyle = { italic = true},\n statementStyle = { bold = true },\n typeStyle = {},\n transparent = false, -- do not set background color\n dimInactive = false, -- dim inactive window `:h hl-NormalNC`\n terminalColors = true, -- define vim.g.terminal_color_{0,17}\n colors = { -- add/modify theme and palette colors\n palette = {},\n theme = { wave = {}, lotus = {}, dragon = {}, all = {} },\n },\n overrides = function(colors) -- add/modify highlights\n return {}\n end,\n theme = \"wave\", -- Load \"wave\" theme when 'background' option is not set\n background = { -- map the value of 'background' option to a theme\n dark = \"wave\", -- try \"dragon\" !\n light = \"lotus\"\n },\n})\n\n-- setup must be called before loading\nvim.cmd(\"colorscheme kanagawa\")\n```\n\n**_NOTE 1:_** If you enable compilation, make sure to run this command every time you make changes to your config.\n**_NOTE 2:_** Kanagawa adjusts to the value of some options. Make sure that the options `'laststatus'` and `'cmdheight'` are set **_before_** calling `setup`.\n\n```vim\n\" 1. Modify your config\n\" 2. Restart nvim\n\" 3. Run this command:\n:KanagawaCompile\n```\n\n## Themes\n\nKanagawa comes in three variants:\n\n- `wave` the default heart-warming theme,\n- `dragon` for those late-night sessions\n- `lotus` for when you're out in the open.\n\nThemes can be changed in three ways:\n\n- Setting `config.theme` to the desired theme. Note that `vim.o.background` **must** be unset.\n- Using the `background` option:\n Any change to the value of `vim.o.background` will select the theme mapped by `config.background`.\n Use `vim.o.background = \"\"` to unset this option.\n- Loading the colorscheme directly with:\n ```lua\n vim.cmd(\"colorscheme kanagawa-wave\")\n vim.cmd(\"colorscheme kanagawa-dragon\")\n vim.cmd(\"colorscheme kanagawa-lotus\")\n ```\n or\n ```lua\n require(\"kanagawa\").load(\"wave\")\n ```\n\n## Customization\n\nIn kanagawa, there are _two_ kinds of colors: `PaletteColors` and `ThemeColors`;\n`PaletteColors` are defined directly as RGB Hex strings, and have arbitrary names\nthat recall their actual color. Conversely, `ThemeColors` are named and grouped _semantically_\non the basis of their actual function.\n\nIn short, a `palette` defines all the available colors, while a `theme` maps the `PaletteColors`\nto specific `ThemeColors` and the same palette color may be assigned to multiple theme colors.\n\nYou can change _both_ theme or palette colors using `config.colors`.\nAll the palette color names can be found [here](lua/kanagawa/colors.lua),\nwhile their usage by each theme can be found [here](lua/kanagawa/themes.lua).\n\n```lua\nrequire('kanagawa').setup({\n ...,\n colors = {\n palette = {\n -- change all usages of these colors\n sumiInk0 = \"#000000\",\n fujiWhite = \"#FFFFFF\",\n },\n theme = {\n -- change specific usages for a certain theme, or for all of them\n wave = {\n ui = {\n float = {\n bg = \"none\",\n },\n },\n },\n dragon = {\n syn = {\n parameter = \"yellow\",\n },\n }\n all = {\n ui = {\n bg_gutter = \"none\"\n }\n }\n }\n },\n ...\n})\n```\n\nYou can also conveniently add/modify `hlgroups` using the `config.overrides` option.\nSupported keywords are the same for `:h nvim_set_hl` `{val}` parameter.\n\n```lua\nrequire('kanagawa').setup({\n ...,\n overrides = function(colors)\n return {\n -- Assign a static color to strings\n String = { fg = colors.palette.carpYellow, italic = true },\n -- theme colors will update dynamically when you change theme!\n SomePluginHl = { fg = colors.theme.syn.type, bold = true },\n }\n end,\n ...\n})\n```\n\n### Common customizations\n\n#### Remove _gutter_ background\n\nRemove the background of `LineNr`, `{Sign,Fold}Column` and friends\n\n```lua\ncolors = {\n theme = {\n all = {\n ui = {\n bg_gutter = \"none\"\n }\n }\n }\n}\n```\n\n#### Transparent Floating Windows\n\nThis will make floating windows look nicer with default borders.\n\n```lua\noverrides = function(colors)\n local theme = colors.theme\n return {\n NormalFloat = { bg = \"none\" },\n FloatBorder = { bg = \"none\" },\n FloatTitle = { bg = \"none\" },\n\n -- Save an hlgroup with dark background and dimmed foreground\n -- so that you can use it where your still want darker windows.\n -- E.g.: autocmd TermOpen * setlocal winhighlight=Normal:NormalDark\n NormalDark = { fg = theme.ui.fg_dim, bg = theme.ui.bg_m3 },\n\n -- Popular plugins that open floats will link to NormalFloat by default;\n -- set their background accordingly if you wish to keep them dark and borderless\n LazyNormal = { bg = theme.ui.bg_m3, fg = theme.ui.fg_dim },\n MasonNormal = { bg = theme.ui.bg_m3, fg = theme.ui.fg_dim },\n }\nend,\n```\n\nIf you'd like to keep the floating windows darker, but you're unhappy with how\nborders are rendered, consider using characters that are drawn at the edges of\nthe box:\n\n```lua\n{ \"🭽\", \"▔\", \"🭾\", \"▕\", \"🭿\", \"▁\", \"🭼\", \"▏\" }\n```\n\n#### Borderless Telescope\n\nBlock-like _modern_ Telescope UI\n\n```lua\noverrides = function(colors)\n local theme = colors.theme\n return {\n TelescopeTitle = { fg = theme.ui.special, bold = true },\n TelescopePromptNormal = { bg = theme.ui.bg_p1 },\n TelescopePromptBorder = { fg = theme.ui.bg_p1, bg = theme.ui.bg_p1 },\n TelescopeResultsNormal = { fg = theme.ui.fg_dim, bg = theme.ui.bg_m1 },\n TelescopeResultsBorder = { fg = theme.ui.bg_m1, bg = theme.ui.bg_m1 },\n TelescopePreviewNormal = { bg = theme.ui.bg_dim },\n TelescopePreviewBorder = { bg = theme.ui.bg_dim, fg = theme.ui.bg_dim },\n }\nend,\n```\n\n#### Dark completion (popup) menu\n\nMore uniform colors for the popup menu.\n\n```lua\noverrides = function(colors)\n local theme = colors.theme\n return {\n Pmenu = { fg = theme.ui.shade0, bg = theme.ui.bg_p1 },\n PmenuSel = { fg = \"NONE\", bg = theme.ui.bg_p2 },\n PmenuSbar = { bg = theme.ui.bg_m1 },\n PmenuThumb = { bg = theme.ui.bg_p2 },\n }\nend,\n```\n\n## Integration\n\n```lua\n-- Get the colors for the current theme\nlocal colors = require(\"kanagawa.colors\").setup()\nlocal palette_colors = colors.palette\nlocal theme_colors = colors.theme\n\n-- Get the colors for a specific theme\nlocal wave_colors = require(\"kanagawa.colors\").setup({ theme = 'wave' })\n```\n\n

Color palette

\n\n| | Name | Hex | Usage |\n| :-----------------------------------------------------: | :------------ | :-------: | :-------------------------------------------------------------------------------- |\n|

| oldWhite | `#C8C093` | Dark foreground (statuslines) |\n|

| sumiInk0 | `#16161D` | Dark background (statuslines and floating windows) |\n|

| sumiInk1 | `#1F1F28` | Default background |\n|

| sumiInk2 | `#2A2A37` | Lighter background (colorcolumn, folds) |\n|

| sumiInk3 | `#363646` | Lighter background (cursorline) |\n|

| sumiInk4 | `#54546D` | Darker foreground (line numbers, fold column, non-text characters), float borders |\n|

| waveBlue1 | `#223249` | Popup background, visual selection background |\n|

| waveBlue2 | `#2D4F67` | Popup selection background, search background |\n|

| winterGreen | `#2B3328` | Diff Add (background) |\n|

| winterYellow | `#49443C` | Diff Change (background) |\n|

| winterRed | `#43242B` | Diff Deleted (background) |\n|

| winterBlue | `#252535` | Diff Line (background) |\n|

| autumnGreen | `#76946A` | Git Add |\n|

| autumnRed | `#C34043` | Git Delete |\n|

| autumnYellow | `#DCA561` | Git Change |\n|

| samuraiRed | `#E82424` | Diagnostic Error |\n|

| waveAqua1 | `#6A9589` | Diagnostic Info |\n|

| dragonBlue | `#658594` | Diagnostic Hint |\n|

| fujiGray | `#727169` | Comments |\n|

| springViolet1 | `#938AA9` | Light foreground |\n|

| oniViolet | `#957FB8` | Statements and Keywords |\n|

| crystalBlue | `#7E9CD8` | Functions and Titles |\n|

| lightBlue | `#A3D4D5` | Not used |\n|

| waveAqua2 | `#7AA89F` | Types |\n|

| springGreen | `#98BB6C` | Strings |\n|

| boatYellow1 | `#938056` | Not used |\n|

| boatYellow2 | `#C0A36E` | Operators, RegEx |\n|

| carpYellow | `#E6C384` | Identifiers |\n|

| sakuraPink | `#D27E99` | Numbers |\n|

| waveRed | `#E46876` | Standout specials 1 (builtin variables) |\n|

| peachRed | `#FF5D62` | Standout specials 2 (exception handling, return) |\n|

| surimiOrange | `#FFA066` | Constants, imports, booleans |\n|

| katanaGray | `#717C7C` | Deprecated |\n\n

\n\n## Extras\n\n- [alacritty](extras/alacritty_kanagawa.yml)\n- [base16](extras/base16-theme.yaml)\n- [broot](extras/broot_kanagawa.toml)\n- [emacs, doom emacs](extras/kanagawa-theme.el)\n- [fish](extras/kanagawa.fish)\n- [foot](extras/foot_kanagawa.ini)\n- [iTerm](extras/kanagawa.itermcolors)\n- [kitty](extras/kanagawa.conf)\n- [mintty](extras/kanagawa.minttyrc)\n- [pywal](extras/pywal-theme.json)\n- [sway](extras/kanagawa.sway)\n- [wezterm](extras/wezterm.lua)\n- [Windows Terminal](extras/windows_terminal.json)\n- [Xresources](extras/.Xresources)\n- [JSON compatible with many terminals](extras/Kanagawa.json) Check [Gogh](https://github.com/Gogh-Co/Gogh#-terminals) for the list of supported terminals.\n- 🎉 Bonus! You win a tiny [python script](palette.py)🐍 to extract color palettes 🎨 from any image! 🥳\n\n## Acknowledgements\n\n- [Tokyonight](https://github.com/folke/tokyonight.nvim)\n- [Gruvbox](https://github.com/morhetz/gruvbox)\n- [Catppuccin](https://github.com/catppuccin/nvim)\n- [Affinity Designer](https://affinity.serif.com/designer/)\n\n### Donate\n\nBuy me coffee and support my work ;)\n\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate/?business=VNQPHGW4JEM3S&no_recurring=0&item_name=Buy+me+coffee+and+support+my+work+%3B%29¤cy_code=EUR)\n","configCount":80}}}]