README.md

Catppuccin for Lua

Usage

Via Luarocks:

luarocks install --server=https://catppuccin.github.io/lua catppuccin

-- Get Mocha palette
local palette = require("catppuccin").mocha()
-- or
local palette = require("catppuccin.mocha")


-- Get the flavor name of currently used palette.
=palette.name --> "mocha"

-- Get Blue color from Mocha palette.
=palette.blue --> { hex: string; rgb: { number, number, number }; hsl: { number, number, number } }

🙋 FAQ

• Q: Is it compatible with any Lua languages?
  A: Yes, it should be compatible. You can use it with Fennel, Moonscript and others. For typed languages like Teal, a type definition for it is already available, you just need to require it in your Teal code.

💝 Thanks to

• Komo

 

Copyright © 2021-present Catppuccin Org