๐จ Soothing pastel theme for Neovim

Catppuccin for Neovim
This port of Catppuccin is special because it was the first one and the one that originated the project itself. Given this, it's important to acknowledge that it all didn't come to be what it is now out of nowhere. So, if you are interested in knowing more about the initial stages of the theme, you can find it under the v0.1 tag.
Previews
๐ป Latte
๐ชด Frappรฉ
๐บ Macchiato
๐ฟ Mocha
Features
- Supports Neovim >= 0.8
- Highly configurable with 4 different flavours and the ability to create your own!
- Compiled configuration for fast startup time
- Integrations with lsp, treesitter and a bunch of plugins
- Support for many other applications
Installation
with Neovim 0.12's vim.pack
vim.pack.add { { src = "https://github.com/catppuccin/nvim", name = "catppuccin" } }
{ "catppuccin/nvim", name = "catppuccin", priority = 1000 }
use { "catppuccin/nvim", as = "catppuccin" }
:Rocks install catppuccin.nvim
Vim support
Support for Vim is provided through the vim branch.
Plug 'catppuccin/nvim', { 'branch': 'vim', 'as': 'catppuccin' }
[!NOTE]
Keep in mind that Vim support has been dropped
(#949) and this branch won't
receive further updates unless necessary. For full Vim support, see
catppuccin/vim. Starting from Vim
v9.2.0219 and Neovim 0.12, catppuccin is shipped with the editors. Note that
it is not maintained by the Catppuccin organization and follows
Vim colorscheme rules
instead of
the official Catppuccin style guide.
Usage
colorscheme catppuccin-nvim " catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha
vim.cmd.colorscheme "catppuccin-nvim"
Configuration
There is no need to call setup if you don't want to change the default options and settings.
require("catppuccin").setup({ flavour = "auto", -- latte, frappe, macchiato, mocha background = { -- :h background light = "latte", dark = "mocha", }, transparent_background = false, -- disables setting the background color. float = { transparent = false, -- enable transparent floating windows solid = false, -- use solid styling for floating windows, see |winborder| }, termcolors = false, -- sets terminal colors (e.g.) dim_inactive = { enabled = false, -- dims the background color of inactive window shade = "dark", percentage = 0.15, -- percentage of the shade to apply to the inactive window }, no_italic = false, -- Force no italic no_bold = false, -- Force no bold no_underline = false, -- Force no underline styles = { -- Handles the styles of general hi groups (seeg:terminalcolor_0:h highlight-args): comments = { "italic" }, -- Change the style of comments conditionals = { "italic" }, loops = {}, functions = {}, keywords = {}, strings = {}, variables = {}, numbers = {}, booleans = {}, properties = {}, types = {}, operators = {}, -- miscs = {}, -- Uncomment to turn off hard-coded styles }, lsp_styles = { -- Handles the style of specific lsp hl groups (see:h lsp-highlight). virtual_text = { errors = { "italic" }, hints = { "italic" }, warnings = { "italic" }, information = { "italic" }, ok = { "italic" }, }, underlines = { errors = { "underline" }, hints = { "underline" }, warnings = { "underline" }, information = { "underline" }, ok = { "underline" }, }, inlay_hints = { background = true, }, }, color_overrides = {}, custom_highlights = {}, default_integrations = true, auto_integrations = false, integrations = { cmp = true, gitsigns = true, nvimtree = true, notify = false, mini = { enabled = true, indentscope_color = "", }, -- For more plugins integrations please scroll down (https://github.com/catppuccin/nvim#integrations) }, })-- setup must be called before loading vim.cmd.colorscheme "catppuccin-nvim"
Customization
Getting colors
local latte = require("catppuccin.palettes").get_palette "latte"
local frappe = require("catppuccin.palettes").get_palette "frappe"
local macchiato = require("catppuccin.palettes").get_palette "macchiato"
local mocha = require("catppuccin.palettes").get_palette "mocha"
Returns a table where the key is the name of the color and the value is the hex code.
Overwriting colors
Colors can be overwritten using color_overrides, see https://github.com/catppuccin/nvim/discussions/323 for inspiration:
require("catppuccin").setup {
color_overrides = {
all = {
text = "#ffffff",
},
latte = {
base = "#ff0000",
mantle = "#242424",
crust = "#474747",
},
frappe = {},
macchiato = {},
mocha = {},
}
}
Overwriting highlight groups
Global highlight groups can be overwritten, for example:
require("catppuccin").setup {
custom_highlights = function(colors)
return {
Comment = { fg = colors.flamingo },
TabLineSel = { bg = colors.pink },
CmpBorder = { fg = colors.surface2 },
Pmenu = { bg = colors.none },
}
end
}
Highlight groups per flavour can also be overwritten, for example:
require("catppuccin").setup {
highlight_overrides = {
all = function(colors)
return {
NvimTreeNormal = { fg = colors.none },
CmpBorder = { fg = "#3e4145" },
}
end,
latte = function(latte)
return {
Normal = { fg = latte.base },
}
end,
frappe = function(frappe)
return {
["@comment"] = { fg = frappe.surface2, style = { "italic" } },
}
end,
macchiato = function(macchiato)
return {
LineNr = { fg = macchiato.overlay1 },
}
end,
mocha = function(mocha)
return {
Comment = { fg = mocha.flamingo },
}
end,
},
}
Integrations
Catppuccin provides theme support for other plugins in the Neovim ecosystem and extended Neovim functionality through integrations.
To enable/disable an integration you just need to set it to true/false, for example:
require("catppuccin").setup({
integrations = {
cmp = true,
gitsigns = true,
nvimtree = true,
notify = false,
mini = {
enabled = true,
indentscope_color = "",
},
}
})
Some integrations are enabled by default, you can control this behaviour with default_integrations option.
require("catppuccin").setup({
default_integrations = false,
})
If you use lazy.nvim as your package manager, you can use the autointegrations option to let catppuccin automatically detect installed plugins and enable their respective integrations.
require("catppuccin").setup({
auto_integrations = true,
})
Below is a list of supported plugins and their corresponding integration module.
[!Important]
If you'd like to see the full list of highlight groups modified by Catppuccin, see the lua/catppuccin/groups/integrations/ directory.
| Plugin | Default |
| |
| |
| artio.nvim |
|
| |
Use this to set it up:
| |
| |
| |
| |
Use this to set it up:
| |
|
Update your bufferline config to use the Catppuccin components: [!NOTE] bufferline needs to be loaded after setting up Catppuccin or it will highlight incorrectly
Configurations are self-explanatory, see
| |
| |
Setting
[!Note] coc.nvim by default link to native lsp highlight groups so
In the nested tables you can set the style for the diagnostics, both
| |
| |
| |
| |
| |
|
Update your Feline config to use the Catppuccin components:
Notice that calling Here are the defaults:
[!Warning] Currently feline doesn't officially support custom themes. In order for
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
| |
| |
| |
For custom Lsp Kind Icon and Color
| |
To implement color overrides in the
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
There're 2 available presets ( Here is how you can use them.
To use another flavour just replace | |
| |
| |
[!NOTE] This plugin has been archived by the author, consider using outline.nvim
| |
| |
| |
| |
|
| |
|
Use this to set it up:
| |
| |
| |
| |
| |
| |
| |
| |
|
Compile
Catppuccin is a highly customizable and configurable colorscheme. This does however come at the cost of complexity and execution time. Catppuccin can pre compute the results of your configuration and store the results in a compiled Lua file. We use these pre-cached values to set it's highlights.
By default, Catppuccin writes the compiled results into the system's cache directory. See below if you'd like to change the cache directory:
require("catppuccin").setup({ -- Note: On windows we replace / with \ by default
compile_path = vim.fn.stdpath "cache" .. "/catppuccin"
})
๐ FAQ
Why do my Treesitter highlights look incorrect?
Please disable additionalvimregex_highlighting:
require("nvim-treesitter.configs").setup {
highlight = {
enable = true,
additionalvimregex_highlighting = false
},
}
Why aren't my colors the same as the previews?
Catppuccin requires that your terminal supports true color, meaning that your terminal can display the full range of 16 million colors.
- Supported: iterm2 (macOS), kitty, wezterm, alacritty, see full list...
- Unsupported: Terminal.app (macOS), Terminus, Terminology, see full list...
๐ Thanks to
Current Maintainer(s)
Previous Maintainer(s)
Copyright © 2021-present Catppuccin Org