https://github.com/catppuccin/lua
🌚 Soothing pastel theme for Lua
https://github.com/catppuccin/lua
catppuccin hacktoberfest library lua luarocks theme
Last synced: 3 months ago
JSON representation
🌚 Soothing pastel theme for Lua
- Host: GitHub
- URL: https://github.com/catppuccin/lua
- Owner: catppuccin
- License: mit
- Created: 2023-06-07T09:16:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T13:52:11.000Z (almost 2 years ago)
- Last Synced: 2024-11-12T00:42:34.279Z (about 1 year ago)
- Topics: catppuccin, hacktoberfest, library, lua, luarocks, theme
- Language: Lua
- Homepage:
- Size: 460 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Catppuccin for Lua
## Usage
Via [Luarocks](https://luarocks.org):
```bash
luarocks install --server=https://catppuccin.github.io/lua catppuccin
```
```lua
-- 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](https://fennel-lang.org), [Moonscript](https://moonscript.org) and others. For typed languages like [Teal](https://github.com/teal-language/tl), a [type definition](/catppuccin.d.tl) for it is already available, you just need to `require` it in your Teal code.
## 💝 Thanks to
- [Komo](https://github.com/cattokomo)
Copyright © 2021-present Catppuccin Org
