Back to Nvim

README

README.md

2.0.037.6 KB
Original Source
<!-- panvimdoc-ignore-start --> <h3 align="center">
Catppuccin for <a href="https://github.com/neovim/neovim">Neovim</a>
</h3> <p align="center"> <a href="https://github.com/catppuccin/nvim/stargazers"></a> <a href="https://github.com/catppuccin/nvim/issues"></a> <a href="https://github.com/catppuccin/nvim/contributors"></a> </p> <p align="center"> </p> <p align="center"> This port of <a href="https://github.com/catppuccin/">Catppuccin</a> 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 <a href="https://github.com/catppuccin/nvim/tree/v0.1">v0.1</a> tag. </p>

Previews

<details> <summary>๐ŸŒป Latte</summary> </details> <details> <summary>๐Ÿชด Frappรฉ</summary> </details> <details> <summary>๐ŸŒบ Macchiato</summary> </details> <details> <summary>๐ŸŒฟ Mocha</summary> </details> <!-- panvimdoc-ignore-end -->

Features

Installation

lazy.nvim

lua
{ "catppuccin/nvim", name = "catppuccin", priority = 1000 }

mini.deps

lua
add({ source = "catppuccin/nvim", name = "catppuccin" })

packer.nvim

lua
use { "catppuccin/nvim", as = "catppuccin" }

with Neovim 0.12's vim.pack

lua
vim.pack.add({ src = "https://github.com/catppuccin/nvim", name = "catppuccin" })

Vim support

Support for Vim is provided through the vim branch.

vim-plug

vim
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

vim
colorscheme catppuccin-nvim " catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha
lua
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.

lua
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|
    },
    term_colors = false, -- sets terminal colors (e.g. `g:terminal_color_0`)
    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 (see `: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

lua
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:

lua
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:

lua
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:

lua
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:

lua
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.

lua
require("catppuccin").setup({
    default_integrations = false,
})

If you use lazy.nvim as your package manager, you can use the auto_integrations option to let catppuccin automatically detect installed plugins and enable their respective integrations.

lua
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.

<table> <!-- panvimdoc-ignore-start --> <tr> <td> <b>Plugin</b> </td> <td> <b>Default</b> </td> </tr> <!-- panvimdoc-ignore-end --> <!-- aerial.nvim --> <tr> <td>

<a href="https://github.com/stevearc/aerial.nvim">aerial.nvim</a>

</td> <td>
lua
aerial = false
</td> </tr> <!-- aerial.nvim --> <!-- alpha.nvim --> <tr> <td>

<a href="https://github.com/goolord/alpha-nvim">alpha-nvim</a>

</td> <td>
lua
alpha = true
</td> </tr> <!-- alpha.nvim --> <!-- artio.nvim --> </tr> <tr <tr> <td> <a href="https://github.com/comfysage/artio.nvim">artio.nvim</a> </td> <td>
lua
artio = true
</td> </tr> <!-- artio.nvim --> <!-- barbar.nvim --> <tr> <td>

<a href="https://github.com/romgrk/barbar.nvim">barbar.nvim</a>

</td> <td>
lua
barbar = false
</td> </tr> <!-- barbar.nvim --> <!-- barbecue.nvim --> <tr> <td>

<a href="https://github.com/utilyre/barbecue.nvim">barbecue.nvim</a>

</td> <td>
lua
barbecue = {
    dim_dirname = true, -- directory name is dimmed by default
    bold_basename = true,
    dim_context = false,
    alt_background = false,
},
<details> <summary>Special</summary>

Use this to set it up:

lua
require("barbecue").setup {
  theme = "catppuccin-nvim", -- catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha
}
</details> </td> </tr> <!-- barbecue.nvim --> <!-- beacon.nvim --> <tr> <td>

<a href="https://github.com/DanilaMihailov/beacon.nvim">beacon.nvim</a>

</td> <td>
lua
beacon = false
</td> </tr> <!-- beacon.nvim --> <!-- blink.cmp --> <tr> <td>

<a href="https://github.com/Saghen/blink.cmp">blink.cmp</a>

</td> <td>
lua
blink_cmp = {
    style = 'bordered',
}
</td> </tr> <!-- blink.cmp --> <!-- blink.indent --> <tr> <td>

<a href="https://github.com/saghen/blink.indent">blink.indent</a>

</td> <td>
lua
blink_indent = true
</td> </tr> <!-- blink.indent --> <!-- blink.pairs --> <tr> <td>

<a href="https://github.com/saghen/blink.pairs">blink.pairs</a>

</td> <td>
lua
blink_pairs = true
<details> <summary>Special</summary>

Use this to set it up:

lua
require("blink.pairs").setup {
    highlights = {
        groups = {
            "BlinkPairsRed",
            "BlinkPairsYellow",
            "BlinkPairsBlue",
            "BlinkPairsOrange",
            "BlinkPairsGreen",
            "BlinkPairsPurple",
            "BlinkPairsCyan",
        },
    },
}
</details> </td> </tr> <!-- blink.pairs --> <!-- bufferline.nvim --> <tr> <td>

<a href="https://github.com/akinsho/bufferline.nvim">bufferline.nvim</a>

</td> <td> <details> <summary>Special</summary>

Update your bufferline config to use the Catppuccin components:

[!NOTE] bufferline needs to be loaded after setting up Catppuccin or it will highlight incorrectly

lua
use "akinsho/bufferline.nvim" {
  after = "catppuccin",
  config = function()
    require("bufferline").setup {
      highlights = require("catppuccin.special.bufferline").get_theme()
    }
  end
}

Configurations are self-explanatory, see :h bufferline-highlights for detailed explanations:

lua
local mocha = require("catppuccin.palettes").get_palette "mocha"
bufferline.setup {
    highlights = require("catppuccin.special.bufferline").get_theme {
        styles = { "italic", "bold" },
        custom = {
            all = {
                fill = { bg = "#000000" },
            },
            mocha = {
                background = { fg = mocha.text },
            },
            latte = {
                background = { fg = "#000000" },
            },
        },
    },
}
</details> </td> </tr> <!-- bufferline.nvim --> <!-- buffon.nvim --> <tr> <td>

<a href="https://github.com/francescarpi/buffon.nvim">buffon.nvim</a>

</td> <td>
lua
buffon = false
</td> </tr> <!-- buffon.nvim --> <!-- coc.nvim --> <tr> <td>

<a href="https://github.com/neoclide/coc.nvim">coc.nvim</a>

</td> <td>
lua
coc_nvim = false
<details> <summary>Special</summary>

Setting enabled to true enables this integration.

lua
coc_nvim = true,

[!Note] coc.nvim by default link to native lsp highlight groups so lsp_styles options will also apply to coc

In the nested tables you can set the style for the diagnostics, both virtual_text (what you see on the side) and underlines (what points directly at the thing (e.g. an error)).

lua
lsp_styles = {
    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,
    },
},
</details> </td> </tr> <!-- coc.nvim --> <!-- colorful-winsep.nvim --> <tr> <td>

<a href="https://github.com/nvim-zh/colorful-winsep.nvim">colorful-winsep.nvim</a>

</td> <td>
lua
colorful_winsep = {
    enabled = false,
    color = "red",
}
</td> </tr> <!-- colorful_winsep.nvim --> <!-- dashboard-nvim --> <tr> <td>

<a href="https://github.com/glepnir/dashboard-nvim">dashboard-nvim</a>

</td> <td>
lua
dashboard = true
</td> </tr> <!-- dashboard-nvim --> <!-- diffview.nvim --> <tr> <td>

<a href="https://github.com/sindrets/diffview.nvim">diffview.nvim</a>

</td> <td>
lua
diffview = false
</td> </tr> <!-- diffview.nvim --> <!-- dropbar.nvim --> <tr> <td>

<a href="https://github.com/Bekaboo/dropbar.nvim">dropbar.nvim</a>

</td> <td>
lua
dropbar = {
    enabled = false,
    color_mode = false, -- enable color for kind's texts, not just kind's icons
},
</td> </tr> <!-- dropbar.nvim --> <!-- feline.nvim --> <tr> <td>

<a href="https://github.com/freddiehaddad/feline.nvim/">feline.nvim</a>

</td> <td> </details> <details> <summary>Special</summary>

Update your Feline config to use the Catppuccin components:

lua
local ctp_feline = require('catppuccin.special.feline')

ctp_feline.setup()

require("feline").setup({
    components = ctp_feline.get_statusline(),
})

Notice that calling setup() is optional. You may pass a lua table in order to change assets, settings and the colors per vim mode.

Here are the defaults:

lua
local clrs = require("catppuccin.palettes").get_palette()
local ctp_feline = require('catppuccin.special.feline')
local U = require "catppuccin.utils.colors"

ctp_feline.setup({
    assets = {
        left_separator = "๎‚ถ",
        right_separator = "๎‚ด",
        mode_icon = "๏†ฎ",
        dir = "๓ฐ‰–",
        file = "๓ฐˆ™",
        lsp = {
            server = "๓ฐ…ก",
            error = "๏„‘",
            warning = "๏„‘",
            info = "๏„‘",
            hint = "๏„‘",
        },
        git = {
            branch = "๎œฅ",
            added = "๏•",
            changed = "๏…„",
            removed = "๏–",
        },
    },
    sett = {
        text = U.vary_color({ latte = latte.base }, clrs.surface0),
        bkg = U.vary_color({ latte = latte.crust }, clrs.surface0),
        diffs = clrs.mauve,
        extras = clrs.overlay1,
        curr_file = clrs.maroon,
        curr_dir = clrs.flamingo,
        show_modified = false, -- show if the file has been modified
        show_lazy_updates = false -- show the count of updatable plugins from lazy.nvim
                                  -- need to set checker.enabled = true in lazy.nvim first
                                  -- the icon is set in ui.icons.plugin in lazy.nvim
    },
    mode_colors = {
        ["n"] = { "NORMAL", clrs.lavender },
        ["no"] = { "N-PENDING", clrs.lavender },
        ["i"] = { "INSERT", clrs.green },
        ["ic"] = { "INSERT", clrs.green },
        ["t"] = { "TERMINAL", clrs.green },
        ["v"] = { "VISUAL", clrs.flamingo },
        ["V"] = { "V-LINE", clrs.flamingo },
        [""] = { "V-BLOCK", clrs.flamingo },
        ["R"] = { "REPLACE", clrs.maroon },
        ["Rv"] = { "V-REPLACE", clrs.maroon },
        ["s"] = { "SELECT", clrs.maroon },
        ["S"] = { "S-LINE", clrs.maroon },
        [""] = { "S-BLOCK", clrs.maroon },
        ["c"] = { "COMMAND", clrs.peach },
        ["cv"] = { "COMMAND", clrs.peach },
        ["ce"] = { "COMMAND", clrs.peach },
        ["r"] = { "PROMPT", clrs.teal },
        ["rm"] = { "MORE", clrs.teal },
        ["r?"] = { "CONFIRM", clrs.mauve },
        ["!"] = { "SHELL", clrs.green },
    },
    view = {
        lsp = {
            progress = true, -- if true the status bar will display an lsp progress indicator
            name = false, -- if true the status bar will display the lsp servers name, otherwise it will display the text "Lsp"
            exclude_lsp_names = {}, -- lsp server names that should not be displayed when name is set to true
            separator = "|", -- the separator used when there are multiple lsp servers
        },
    }
})

[!Warning] Currently feline doesn't officially support custom themes. In order for :colorscheme catppuccin-<flavour> to work you could add this autocmd as a workaround:

lua
vim.api.nvim_create_autocmd("ColorScheme", {
    pattern = "*",
    callback = function()
        package.loaded["feline"] = nil
        package.loaded["catppuccin.special.feline"] = nil
        require("feline").setup {
            components = require("catppuccin.special.feline").get_statusline(),
        }
    end,
})
</details> </td> </tr> <!-- feline.nvim --> <!-- fern.vim --> <tr> <td>

<a href="https://github.com/lambdalisue/fern.vim">fern.vim</a>

</td> <td>
lua
fern = false
</td> </tr> <!-- fern.vim --> <!-- fidget.nvim --> <tr> <td>

<a href="https://github.com/j-hui/fidget.nvim">fidget.nvim</a>

</td> <td>
lua
fidget = false
<details> <summary>Special</summary> Set `notification.window.winblend` to `0`:
lua
require("fidget").setup {
    notification = {
        window = {
            winblend = 0,
        },
    }
    -- ... the rest of your fidget config
}
</details> </td> </tr> <!-- fidget.nvim --> <!-- flash.nvim --> <tr> <td>

<a href="https://github.com/folke/flash.nvim">flash.nvim</a>

</td> <td>
lua
flash = true
<!-- flash.nvim --> <!-- fzf-lua --> <tr> <td>

<a href="https://github.com/ibhagwan/fzf-lua">fzf-lua</a>

</td> <td>
lua
fzf = true
</td> </tr> <!-- fzf-lua --> <!-- gitgraph.nvim --> <tr> <td>

<a href="https://github.com/isakbm/gitgraph.nvim">gitgraph.nvim</a>

</td> <td>
lua
gitgraph = false
<!-- gitgraph.nvim --> <!-- gitsigns.nvim --> <tr> <td>

<a href="https://github.com/lewis6991/gitsigns.nvim">gitsigns.nvim</a>

</td> <td>
lua
gitsigns = true
<details> <summary>Special</summary>
lua
gitsigns = {
  enabled = true,
  -- align with the transparent_background option by default
  transparent = false,
}
</details> <!-- gitsigns.nvim --> <!-- grug-far.nvim --> <tr> <td>

<a href="https://github.com/MagicDuck/grug-far.nvim">grug-far.nvim</a>

</td> <td>
lua
grug_far = false
<!-- grug-far.nvim --> <!-- harpoon --> <tr> <td>

<a href="https://github.com/ThePrimeagen/harpoon">harpoon</a>

</td> <td>
lua
harpoon = false
<!-- harpoon --> <!-- headlines.nvim --> <tr> <td>

<a href="https://github.com/lukas-reineke/headlines.nvim">headlines.nvim</a>

</td> <td>
lua
headlines = false
<!-- headlines.nvim --> <!-- hop.nvim --> <tr> <td>

<a href="https://github.com/phaazon/hop.nvim">hop.nvim</a>

</td> <td>
lua
hop = false
<!-- hop.nvim --> <!-- indent-blankline.nvim --> <tr> <td>

<a href="https://github.com/lukas-reineke/indent-blankline.nvim">indent-blankline.nvim</a>

</td> <td>
lua
indent_blankline = {
    enabled = true,
    scope_color = "", -- catppuccin color (eg. `lavender`) Default: text
    colored_indent_levels = false,
},

<details> <summary>Special</summary>

colored_indent_levels enables char highlights per indent level. Follow the instructions here to set the latter up.

</details> <!-- indent-blankline.nvim --> <!-- leap.nvim --> <tr> <td>

<a href="https://github.com/ggandor/leap.nvim">leap.nvim</a>

</td> <td>
lua
leap = false
<!-- leap.nvim --> <!-- lightline.vim --> <tr> <td>

<a href="https://github.com/itchyny/lightline.vim">lightline.vim</a>

</td> <td> <details> <summary>Special</summary>
vim
let g:lightline = {'colorscheme': 'catppuccin'}
</details> <!-- lightline.vim --> <!-- lightspeed.nvim --> <tr> <td>

<a href="https://github.com/ggandor/lightspeed.nvim">lightspeed.nvim</a>

</td> <td>
lua
lightspeed = false
<!-- lightspeed.nvim --> <!-- lir.nvim --> <tr> <td>

<a href="https://github.com/tamago324/lir.nvim">lir.nvim</a>

</td> <td>
lua
lir = {
    enabled = false,
    git_status = false
}
<!-- lir.nvim --> <!-- lspsaga.nvim --> <tr> <td>

<a href="https://github.com/glepnir/lspsaga.nvim">lspsaga.nvim</a>

</td> <td>
lua
lsp_saga = false
<details> <summary>Special</summary>

For custom Lsp Kind Icon and Color

lua
require("lspsaga").setup {
    ui = {
        kind = require("catppuccin.groups.integrations.lsp_saga").custom_kind(),
    },
}
</details> </tr> <!-- lspsaga.nvim --> <!-- lualine.nvim --> <tr> <td>

<a href="https://github.com/nvim-lualine/lualine.nvim">lualine.nvim</a>

</td> <td>
lua
-- transparent_bg = opts.transparent_background and "NONE" or C.mantle
lualine = {
    normal = {
        a = { bg = C.blue, fg = C.mantle, gui = "bold" },
        b = { bg = C.surface0, fg = C.blue },
        c = { bg = transparent_bg, fg = C.text },
    },

    insert = {
        a = { bg = C.green, fg = C.base, gui = "bold" },
        b = { bg = C.surface0, fg = C.green },
    },

    terminal = {
        a = { bg = C.green, fg = C.base, gui = "bold" },
        b = { bg = C.surface0, fg = C.green },
    },

    command = {
        a = { bg = C.peach, fg = C.base, gui = "bold" },
        b = { bg = C.surface0, fg = C.peach },
    },
    visual = {
        a = { bg = C.mauve, fg = C.base, gui = "bold" },
        b = { bg = C.surface0, fg = C.mauve },
    },
    replace = {
        a = { bg = C.red, fg = C.base, gui = "bold" },
        b = { bg = C.surface0, fg = C.red },
    },
    inactive = {
        a = { bg = transparent_bg, fg = C.blue },
        b = { bg = transparent_bg, fg = C.surface1, gui = "bold" },
        c = { bg = transparent_bg, fg = C.overlay0 },
    },
},
<details> <summary>Special</summary>

To implement color overrides in the integrations.lualine spec:

lua
-- In your catppuccin config (integrations):
lualine = {
    -- lualine color overrides in the following hierarchy: Catppuccin Flavor -> Mode -> Lualine Section
    -- The Catppuccin flavor entry can be any Catpuccin flavor or "all" to apply to all flavors
    -- The flavor entry can be either a table or a function which consumes the current Catppuccin palette, just like custom_highlights and color_overrides
    all = function(colors)
        ---@type CtpIntegrationLualineOverride
        return {
            -- Specifying a normal-mode status line override for section a's background and b's foreground to use lavender like the main Catppuccin theme
            normal = {
                a = { bg = colors.lavender, gui = "italic" },
                b = { fg = colors.lavender },
            }
        }
    end,
    -- A macchiato-specific override, which takes priority over 'all'. Also using the direct table syntax instead of function in case you do not rely on dynamic palette colors
    macchiato = {
        normal = {
            a = { bg = "#abcdef" },
        }
    },
},
--  And in your lualine config:
require('lualine').setup {
    options = {
        -- lualine will integrate with catppuccin by name or automatically via `vim.g.colors_name` by setting this to "auto"
        theme = "catppuccin-nvim"
        -- ... the rest of your lualine config
    }
}
</details> <!-- lualine.nvim --> <!-- markview.nvim --> <tr> <td>

<a href="https://github.com/OXY2DEV/markview.nvim">markview.nvim</a>

</td> <td>
lua
markview = false
</td> </tr> <!-- markview.nvim --> <!-- mason.nvim --> <tr> <td>

<a href="https://github.com/williamboman/mason.nvim">mason.nvim</a>

</td> <td>
lua
mason = false
</td> </tr> <!-- mason.nvim --> <!-- mini.nvim --> <tr> <td>

<a href="https://github.com/echasnovski/mini.nvim">mini.nvim</a>

</td> <td>
lua
mini = {
    enabled = true,
    indentscope_color = "", -- catppuccin color (eg. `lavender`) Default: text
},
</td> </tr> <!-- mini.nvim --> <!-- neo-tree.nvim --> <tr> <td>

<a href="https://github.com/nvim-neo-tree/neo-tree.nvim">neo-tree.nvim</a>

</td> <td>
lua
neotree = true
</td> </tr> <!-- neo-tree.nvim --> <!-- neogit --> <tr> <td>

<a href="https://github.com/NeogitOrg/neogit">neogit</a>

</td> <td>
lua
neogit = true
</td> </tr> <!-- neogit --> <!-- neotest --> <tr> <td>

<a href="https://github.com/nvim-neotest/neotest">neotest</a>

</td> <td>
lua
neotest = false
</td> </tr> <!-- neotest --> <!-- noice.nvim --> <tr> <td>

<a href="https://github.com/folke/noice.nvim">noice.nvim</a>

</td> <td>
lua
noice = false
</td> </tr> <!-- noice.nvim --> <!-- notifier.nvim --> <tr> <td>

<a href="https://github.com/vigoux/notifier.nvim">notifier.nvim</a>

</td> <td>
lua
notifier = false
</td> </tr> <!-- notifier.nvim --> <!-- nvim-cmp --> <tr> <td>

<a href="https://github.com/hrsh7th/nvim-cmp">nvim-cmp</a>

</td> <td>
lua
cmp = true
</td> </tr> <!-- nvim-cmp --> <!-- nvim-copilot-vim --> <tr> <td>

<a href="https://github.com/github/copilot.vim">copilot.vim</a>

</td> <td>
lua
copilot_vim = false,
</td> </tr> <!-- nvim-copilot-vim --> <!-- nvim-dap --> <tr> <td>

<a href="https://github.com/mfussenegger/nvim-dap">nvim-dap</a>

</td> <td>
lua
dap = true
<details> <summary>Special</a> </summary>
lua
local sign = vim.fn.sign_define

sign("DapBreakpoint", { text = "โ—", texthl = "DapBreakpoint", linehl = "", numhl = ""})
sign("DapBreakpointCondition", { text = "โ—", texthl = "DapBreakpointCondition", linehl = "", numhl = ""})
sign("DapLogPoint", { text = "โ—†", texthl = "DapLogPoint", linehl = "", numhl = ""})
</details> </td> </tr> <!-- nvim-dap --> <!-- nvim-dap-ui --> <tr> <td>

<a href="https://github.com/rcarriga/nvim-dap-ui">nvim-dap-ui</a>

</td> <td>
lua
dap_ui = true
</td> </tr> <!-- nvim-dap-ui --> <!-- navic --> <tr> <td>

<a href="https://github.com/SmiteshP/nvim-navic">navic</a>

</td> <td>
lua
navic = {
    enabled = false,
    custom_bg = "NONE", -- "lualine" will set background to mantle
},

<details> <summary>Special</summary>
lua
-- You NEED to enable highlight in nvim-navic setting or it won't work
require("nvim-navic").setup {
    highlight = true
}
</details> </td> </tr> <!-- navic --> <!-- nvim-notify --> <tr> <td>

<a href="https://github.com/rcarriga/nvim-notify">nvim-notify</a>

</td> <td>
lua
notify = false
</td> </tr> <!-- nvim-notify --> <!-- nvim-surround --> <tr> <td>

<a href="https://github.com/kylechui/nvim-surround">nvim-surround</a>

</td> <td>
lua
nvim_surround = false
</td> </tr> <!-- nvim-surround --> <!-- nvim-tree.lua --> <tr> <td>

<a href="https://github.com/kyazdani42/nvim-tree.lua">nvim-tree.lua</a>

</td> <td>
lua
nvimtree = true
</td> </tr> <!-- nvim-tree.lua --> <!-- nvim-treesitter-context --> <tr> <td>

<a href="https://github.com/nvim-treesitter/nvim-treesitter-context">nvim-treesitter-context</a>

</td> <td>
lua
treesitter_context = true
</td> </tr> <!-- nvim-treesitter-context --> <!-- nvim-ts-rainbow2 --> <tr> <td>

<a href="https://github.com/HiPhish/nvim-ts-rainbow2">nvim-ts-rainbow2</a>

</td> <td>
lua
ts_rainbow2 = false
</td> </tr> <!-- nvim-ts-rainbow2 --> <!-- nvim-ts-rainbow --> <tr> <td>

<a href="https://github.com/p00f/nvim-ts-rainbow">nvim-ts-rainbow</a>

</td> <td>
lua
ts_rainbow = false
</td> </tr> <!-- nvim-ts-rainbow --> <!-- nvim-ufo --> <tr> <td>

<a href="https://github.com/kevinhwang91/nvim-ufo">nvim-ufo</a>

</td> <td>
lua
ufo = true
</td> </tr> <!-- nvim-ufo --> <!-- nvim-window-picker --> <tr> <td>

<a href="https://github.com/s1n7ax/nvim-window-picker">nvim-window-picker</a>

</td> <td>
lua
window_picker = false
<!-- nvim-window-picker --> <!-- octo.nvim --> <tr> <td>

<a href="https://github.com/pwntester/octo.nvim">octo.nvim</a>

</td> <td>
lua
octo = false
</td> </tr> <!-- octo.nvim --> <!-- overseer.nvim --> <tr> <td>

<a href="https://github.com/stevearc/overseer.nvim">overseer.nvim</a>

</td> <td>
lua
overseer = false
</td> </tr> <!-- overseer.nvim --> <!-- pounce.nvim --> <tr> <td>

<a href="https://github.com/rlane/pounce.nvim">pounce.nvim</a>

</td> <td>
lua
pounce = false
</td> </tr> <!-- pounce.nvim --> <!-- rainbow-delimiters.nvim --> <tr> <td>

<a href="https://github.com/HiPhish/rainbow-delimiters.nvim">rainbow-delimiters.nvim</a>

</td> <td>
lua
rainbow_delimiters = true
</td> </tr> <!-- rainbow-delimiters.nvim --> <!-- reactive.nvim --> <tr> <td>

<a href="https://github.com/rasulomaroff/reactive.nvim">reactive.nvim</a>

</td> <td> <details> <summary>Special</summary>

There're 2 available presets (cursor and cursorline) for every flavour.

Here is how you can use them.

lua
require('reactive').setup {
  load = { 'catppuccin-mocha-cursor', 'catppuccin-mocha-cursorline' }
}

To use another flavour just replace mocha with the one you want to use.

</details> </td> </tr> <!-- reactive.nvim --> <!-- render-markdown.nvim --> <tr> <td>

<a href="https://github.com/MeanderingProgrammer/render-markdown.nvim">render-markdown.nvim</a>

</td> <td>
lua
render_markdown = true
</td> </tr> <!-- render-markdown.nvim --> <!-- snacks.nvim --> <tr> <td>

<a href="https://github.com/folke/snacks.nvim">snacks.nvim</a>

</td> <td>
lua
snacks = {
    enabled = false,
    indent_scope_color = "", -- catppuccin color (eg. `lavender`) Default: overlay2
}
</td> </tr> <!-- snacks.nvim --> <!-- symbols-outline.nvim --> <tr> <td>

<a href="https://github.com/simrat39/symbols-outline.nvim">symbols-outline.nvim</a>

</td> <td>

[!NOTE] This plugin has been archived by the author, consider using outline.nvim

lua
symbols_outline = false
</td> </tr> <!-- symbols-outline.nvim --> <!-- telekasten.nvim --> <tr> <td>

<a href="https://github.com/renerocksai/telekasten.nvim">telekasten.nvim</a>

</td> <td>
lua
telekasten = false
</td> </tr> <!-- telekasten.nvim --> <!-- telescope.nvim --> <tr> <td>

<a href="https://github.com/nvim-telescope/telescope.nvim">telescope.nvim</a>

</td> <td>
lua
telescope = {
    enabled = true,
}
</td> </tr> <!-- telescope.nvim --> <!-- trouble.nvim --> <tr> <td>

<a href="https://github.com/folke/trouble.nvim">trouble.nvim</a>

</td> <td>
lua
lsp_trouble = false
</td> </tr> <!-- trouble.nvim --> <!-- vim-airline --> <tr> <td>

<a href="https://github.com/vim-airline/vim-airline">vim-airline</a>

</td> <td> <details> <summary>Special</summary>
vim
let g:airline_theme = 'catppuccin'
</details> </td> </tr> <!-- vim-airline --> <!-- vim-clap --> <tr> <td>

<a href="https://github.com/liuchengxu/vim-clap">vim-clap</a>

</td> <td> <details> <summary>Special</summary>

Use this to set it up:

vim
let g:clap_theme = 'catppuccin'
</details> </td> </tr> <!-- vim-clap --> <!-- vim-dadbod-ui --> <tr> <td>

<a href="https://github.com/kristijanhusak/vim-dadbod-ui">vim-dadbod-ui</a>

</td> <td>
lua
dadbod_ui = false
</td> </tr> <!-- vim-dadbod-ui --> <!-- vim-gitgutter --> <tr> <td>

<a href="https://github.com/airblade/vim-gitgutter">vim-gitgutter</a>

</td> <td>
lua
gitgutter = false
</td> </tr> <!-- vim-gitgutter --> <!-- vim-illuminate --> <tr> <td>

<a href="https://github.com/RRethy/vim-illuminate">vim-illuminate</a>

</td> <td>
lua
illuminate = {
    enabled = true,
    lsp = false
}
</td> </tr> <!-- vim-illuminate --> <!-- vim-sandwich --> <tr> <td>

<a href="https://github.com/machakann/vim-sandwich">vim-sandwich</a>

</td> <td>
lua
sandwich = false
</td> </tr> <!-- vim-sandwich --> <!-- vim-signify --> <tr> <td>

<a href="https://github.com/mhinz/vim-signify">vim-signify</a>

</td> <td>
lua
signify = false
</td> </tr> <!-- vim-signify --> <!-- vim-sneak --> <tr> <td>

<a href="https://github.com/justinmk/vim-sneak">vim-sneak</a>

</td> <td>
lua
vim_sneak = false
</td> </tr> <!-- vim-sneak --> <!-- vimwiki --> <tr> <td>

<a href="https://github.com/vimwiki/vimwiki">vimwiki</a>

</td> <td>
lua
vimwiki = false
</td> </tr> <!-- vimwiki --> <!-- which-key.nvim --> <tr> <td>

<a href="https://github.com/folke/which-key.nvim">which-key.nvim</a>

</td> <td>
lua
which_key = false
</td> </tr> <!-- which-key.nvim --> </table>

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:

lua
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 additional_vim_regex_highlighting:

lua
require("nvim-treesitter.configs").setup {
    highlight = {
        enable = true,
        additional_vim_regex_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.

If you use tmux, make sure to enable true color support and italic font support. This will prevent issues raised in #415 and #428.

๐Ÿ’ Thanks to

Current Maintainer(s)

Previous Maintainer(s)

<!-- panvimdoc-ignore-start -->

ย 

<p align="center"></p> <p align="center">Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a> <p align="center"><a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"></a></p> <!-- panvimdoc-ignore-end -->