7.6 KiB
About
🌲 Table of Contents
🎁 Features
- ...
📺 Notices
Checkout the CHANGELOG.md file for more information on the notices below:
- 22-08-21: Just released!
Old notices...
📦 Installation
Prerequisites
Adding the plugin
You can use your favorite plugin manager for this. Here are some examples with the most popular ones:
Vim-plug
Plug 'Pocco81/Catppuccino.nvim'
Packer.nvim
use "Pocco81/Catppuccino.nvim"
Vundle
Plugin 'Pocco81/Catppuccino.nvim'
NeoBundle
NeoBundleFetch 'Pocco81/Catppuccino.nvim'
Setup (configuration)
There are already some sane defaults that you may like, however you can change them to match your taste. These are the defaults:
colorscheme = "catppuccino",
transparency = false,
styles = {
comments = "italic",
fuctions = "italic",
keywords = "italic",
strings = "NONE",
variables = "NONE",
},
integrations = {
treesitter = true,
native_lsp = {
enabled = true,
styles = {
errors = "italic",
hints = "italic",
warnings = "italic",
information = "italic"
}
},
lsp_trouble = false,
lsp_saga = false,
gitgutter = false,
gitsigns = false,
telescope = false,
nvimtree = false,
which_key = false,
indent_blankline = false,
dashboard = false,
neogit = false,
vim_sneak = false,
fern = false,
barbar = false,
bufferline = false,
markdown = 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 catppuccino = require("catppuccino")
-- configure it
catppuccino.setup(
{
colorscheme = "catppuccino",
transparency = false,
styles = {
comments = "italic",
fuctions = "italic",
keywords = "italic",
strings = "NONE",
variables = "NONE",
},
integrations = {
treesitter = true,
native_lsp = {
enabled = true,
styles = {
errors = "italic",
hints = "italic",
warnings = "italic",
information = "italic"
}
},
lsp_trouble = false,
lsp_saga = false,
gitgutter = false,
gitsigns = false,
telescope = false,
nvimtree = false,
which_key = false,
indent_blankline = false,
dashboard = false,
neogit = false,
vim_sneak = false,
fern = false,
barbar = false,
bufferline = false,
markdown = false,
}
}
)
-- load it
catppuccino.load()
For init.vim
lua << EOF
local catppuccino = require("catppuccino")
-- configure it
catppuccino.setup(
{
colorscheme = "catppuccino",
transparency = false,
styles = {
comments = "italic",
fuctions = "italic",
keywords = "italic",
strings = "NONE",
variables = "NONE",
},
integrations = {
treesitter = true,
native_lsp = {
enabled = true,
styles = {
errors = "italic",
hints = "italic",
warnings = "italic",
information = "italic"
}
},
lsp_trouble = false,
lsp_saga = false,
gitgutter = false,
gitsigns = false,
telescope = false,
nvimtree = false,
which_key = false,
indent_blankline = false,
dashboard = false,
neogit = false,
vim_sneak = false,
fern = false,
barbar = false,
bufferline = false,
markdown = false,
}
}
)
-- load it
catppuccino.load()
EOF
For instructions on how to configure the plugin, check out the configuration section.
Updating
This depends on your plugin manager. If, for example, you are using Packer.nvim, you can update it with this command:
:PackerUpdate
🤖 Usage
Commands
The only command provided follows the camel casing naming convention and has the CP prefix so that it's easy to remember that it's part of Catppuccino.nvim:
:CPLoad <colorscheme>loads the passed<colorscheme>.
🐬 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.
colorscheme: (String) code name of the color-scheme to be used. All of them can be found in the section below.
List of colorschemes
🙋 FAQ
-
Q: "How can I view the doc from NeoVim?" A: Use
:help Catppuccino.nvim -
Q: "Why are the colorschemes named like that? Do they follow any convention(s)?" A: A colorscheme's name is constructed by two words: the first one is a word that represents the tonalities in the colors used and the second one is the name of a coffee drink from this list.
🫂 Contribute
Pull Requests are welcomed as long as they are properly justified and there are no conflicts. If your PR has something to do with the README or in general related with the documentation, I'll gladly merge it! Also, when writing code for the project you must use the .editorconfig file on your editor so as to "maintain consistent coding styles". For instructions on how to use this file refer to EditorConfig's website.
💭 Inspirations
The following projects inspired the creation of Catppuccino.nvim. If possible, go check them out to see why they are so amazing :]
- folke/tokyonight.nvim: A clean, dark Neovim theme written in Lua, with support for lsp, treesitter and lots of plugins. Includes additional themes for Kitty, Alacritty, iTerm and Fish.
- norcalli/nvim-base16.lua: Programmatic lua library for setting base16 themes in Neovim.
📜 License
Catppuccino.nvim is released under the GPL v3.0 license. It grants open-source permissions for users including:
- The right to download and run the software freely
- The right to make changes to the software as desired
- The right to redistribute copies of the software
- The right to modify and distribute copies of new versions of the software
For more convoluted language, see the LICENSE file.
📋 TO-DO
High Priority
- Add Aquamarine Frappé
Low Priority
- Finish DOC
- Add more integrations
Enjoy!