catppuccin/nvim

github github
tree-sitter-supported-colorscheme
star 435
stars
alert-circle 4
open issues
users 9
subscribers
git-branch 33
forks
CREATED

2021-08-17

UPDATED

yesterday


About

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 old-catppuccino branch.

ğŸŽ Features

Usage

You can use your favorite plugin manager for this. Here are some examples with the most popular ones:

Vim-plug

Plug 'catppuccin/nvim', {'as': 'catppuccin'}

Packer.nvim

use({
    "catppuccin/nvim",
    as = "catppuccin"
})

Vundle

Plugin 'catppuccin/nvim', {'name': 'catppuccin'}

Setup

There are already some sane defaults that you may like, however you can change them to match your taste. These are the defaults:

transparent_background = false,
term_colors = false,
styles = {
    comments = "italic",
    functions = "italic",
    keywords = "italic",
    strings = "NONE",
    variables = "italic",
},
integrations = {
    treesitter = true,
    native_lsp = {
        enabled = true,
        virtual_text = {
            errors = "italic",
            hints = "italic",
            warnings = "italic",
            information = "italic",
        },
        underlines = {
            errors = "underline",
            hints = "underline",
            warnings = "underline",
            information = "underline",
        },
    },
    lsp_trouble = false,
    cmp = true,
    lsp_saga = false,
    gitgutter = false,
    gitsigns = true,
    telescope = true,
    nvimtree = {
        enabled = true,
        show_root = false,
        transparent_panel = false,
    },
    which_key = false,
    indent_blankline = {
        enabled = true,
        colored_indent_levels = false,
    },
    dashboard = true,
    neogit = false,
    vim_sneak = false,
    fern = false,
    barbar = false,
    bufferline = true,
    markdown = true,
    lightspeed = false,
    ts_rainbow = false,
    hop = false,
    notify = true,
    telekasten = true,
}

The way you setup the settings on your configuration varies on whether you are using vimL for this or Lua.

local catppuccin = require("catppuccin")

-- configure it
catppuccin.setup(<settings>)
lua << EOF
local catppuccin = require("catppuccin")

-- configure it
catppuccin.setup(<settings>)
EOF

After setting things up, you can load catppuccin like so:

" Vim Script
colorscheme catppuccin
-- Lua
vim.cmd[[colorscheme catppuccin]]

Configuration

Although settings already have self-explanatory names, here is where you can find info about each one of them and their classifications!

General

This settings are unrelated to any group and are independent.

  • transparent_background: (Boolean) if true, disables setting the background color.
  • term_colors: (Boolean) if true, sets terminal colors (e.g. g:terminal_color_0).

Styles

Handles the style of general hi groups (see :h highlight-args):

  • comments: (String) changed the style of the comments.
  • functions: (String) changed the style of the functions.
  • keywords: (String) changed the style of the keywords.
  • strings: (String) changed the style of the strings.
  • variables: (String) changed the style of the variables.

Integrations

These integrations allow catppuccin to set the theme of various plugins/stuff. To enable an integration you just need to set it to true, however, there are some special integrations...

If you'd like to know which highlight groups are being affected by catppuccin, checkout this directory: lua/catppuccin/core/integrations/.

Special Integrations
  • Feline.nvim: Catppuccin provides this integration as a component that you can select on your Feline config:
require("feline").setup({
    components = require('catppuccin.core.integrations.feline'),
})
  • Indent-blankline.nvim: setting enabled to true enables this integration. colored_indent_levels enables char highlights per indent level. Follow the instructions here to set the latter up.
  • Lightline: use this to set it up (Note: catppuccin is the only valid colorscheme name. It will pick the one set in your config):
let g:lightline = {'colorscheme': 'catppuccin'}
  • Lualine: use this to set it up (Note: catppuccin is the only valid theme name. It will pick the one set in your config):
require('lualine').setup {
  options = {
    theme = "catppuccin"
    -- ... the rest of your lualine config
  }
}
  • Native Nvim LSP: setting enabled to true enables this integration. In the inners 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)).
  • NvimTree: setting enabled to true enables this integration:
integration = {
  nvimtree = {
    enabled = true,
    show_root = true, -- makes the root folder not transparent
    transparent_panel = false, -- make the panel transparent
  }
}

Extra

API

The API allows you fetch data from Catppuccin. It can be required as a Lua module:

local cp_api = require("catppuccin.api.<module>")
Modules
  • colors
cp_api.get_colors()

Returns a table where the key is the name of the color and the value is its hex value.

Overwriting highlight groups

Highlight groups can be overwritten like so:

catppuccin.remap({ <hi_group> = { <fields> }, })

Here is an example:

local colors = require'catppuccin.api.colors'.get_colors() -- fetch colors with API
catppuccin.remap({ Comment = { fg = colors.catppuccin2 }, })

Hooks

Use them to execute code at certain events. These are the ones available:

Function Description
before_loading() Before loading a colorscheme
after_loading() After loading a colorscheme

They can be used like so:

local catppuccin = require("catppuccin")

catppuccin.before_loading = function ()
    print("I ran before loading Catppuccin!")
end

💝 Thanks to