c04abe05a6 | 3 years ago | |
---|---|---|
autoload/lightline/colorscheme | 3 years ago | |
colors | 3 years ago | |
lua | 3 years ago | |
plugin | 3 years ago | |
.editorconfig | 3 years ago | |
.gitignore | 3 years ago | |
CONTRIBUTING.md | 3 years ago | |
LICENSE.md | 3 years ago | |
README.md | 3 years ago | |
stylua.toml | 3 years ago |
README.md
😸 Catppuccin for NeoVim
Warm mid-tone dark theme to show off your vibrant self!
🎁 Features
- Handy CLI.
- Extensible for many use cases.
- Integrations with a bunch of plugins:
Usage
You can use your favorite plugin manager for this. Here are some examples with the most popular ones:
Vim-plug
Plug 'catppuccin/nvim'
Packer.nvim
use "catppuccin/nvim"
Vundle
Plugin 'catppuccin/nvim'
NeoBundle
NeoBundleFetch 'catppuccin/nvim'
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 = "NONE",
},
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,
lsp_saga = false,
gitgutter = false,
gitsigns = false,
telescope = false,
nvimtree = {
enabled = false,
show_root = false,
},
which_key = false,
indent_blankline = {
enabled = false,
colored_indent_levels = false,
},
dashboard = false,
neogit = false,
vim_sneak = false,
fern = false,
barbar = false,
bufferline = false,
markdown = false,
lightspeed = false,
ts_rainbow = false,
hop = false,
},
The way you setup the settings on your configuration varies on whether you are using vimL for this or Lua.
For init.lua
local catppuccin = require("catppuccin")
-- configure it
catppuccin.setup(
{
transparent_background = false,
term_colors = false,
styles = {
comments = "italic",
functions = "italic",
keywords = "italic",
strings = "NONE",
variables = "NONE",
},
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,
lsp_saga = false,
gitgutter = false,
gitsigns = false,
telescope = false,
nvimtree = {
enabled = false,
show_root = false,
},
which_key = false,
indent_blankline = {
enabled = false,
colored_indent_levels = false,
},
dashboard = false,
neogit = false,
vim_sneak = false,
fern = false,
barbar = false,
bufferline = false,
markdown = false,
lightspeed = false,
ts_rainbow = false,
hop = false,
},
}
)
For init.vim
lua << EOF
local catppuccin = require("catppuccin")
-- configure it
catppuccin.setup(
{
transparent_background = false,
term_colors = false,
styles = {
comments = "italic",
functions = "italic",
keywords = "italic",
strings = "NONE",
variables = "NONE",
},
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,
lsp_saga = false,
gitgutter = false,
gitsigns = false,
telescope = false,
nvimtree = {
enabled = false,
show_root = false,
},
which_key = false,
indent_blankline = {
enabled = false,
colored_indent_levels = false,
},
dashboard = false,
neogit = false,
vim_sneak = false,
fern = false,
barbar = false,
bufferline = false,
markdown = false,
lightspeed = false,
ts_rainbow = false,
hop = false,
},
}
)
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
- Native Nvim LSP: setting
enabled
totrue
enables this integration. In the inners tables you can set the style for the diagnostics, bothvirtual_text
(what you see on the side) andunderlines
(what points directly at the thing (e.g. an error)). - 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
}
}
- 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'}
- Kitty: Copy and paste the file corresponding to theme you want to use from this directory on your Kitty config.
- Alacritty: Copy and paste the file corresponding to theme you want to use from this directory on your Alacritty config.
- Tmux: Follow the instructions here
- Indent-blankline.nvim: setting
enabled
totrue
enables this integration.colored_indent_levels
enables char highlights per indent level. Follow the instructions here to set the latter up. - NvimTree: setting
enabled
totrue
enables this integration:
integration = {
nvimtree = {
enabled = true,
show_root = true, -- makes the root folder not transparent
}
}
🙋 FAQ
- Q: "How can I view the doc from NeoVim?"
A: Use
:help catppuccin