gleam/README.md at master

mirror of https://github.com/catppuccin/gleam.git synced 2026-01-09 05:40:58 +08:00

* ci(release): set perms

* docs: update ci/cd release workflow section

2024-05-18 20:06:40 +03:00

3.5 KiB

Raw Permalink Blame History

Catppuccin for Gleam

📦 Installation

gleam add catppuccin

🚀 Usage

import catppuccin
import gleam/io
import gleam_community/colour

pub fn main() {
  catppuccin.frappe()
  |> catppuccin.flavor_name
  |> io.debug
  // "Frappé"

  catppuccin.macchiato()
  |> catppuccin.subtext1
  |> catppuccin.color_name
  |> io.debug
  // "Subtext 1"

  catppuccin.mocha()
  |> catppuccin.mauve
  |> catppuccin.to_color
  |> colour.to_rgba
  |> io.debug
  // #(0.796078431372549, 0.6509803921568628, 0.9686274509803922, 1.0)

  catppuccin.latte()
  |> catppuccin.mauve
  |> catppuccin.to_color
  |> colour.to_hsla
  |> io.debug
  // #(0.739010989010989, 0.8504672897196262, 0.5803921568627451, 1.0)
}

🙋 FAQ

Q: "Where can I find the doc?"
A: Further documentation can be found at https://hexdocs.pm/catppuccin.

🛠️ Development

The project under codegen directory is used to generate the library based on the contents of palette.json.

Clone this repository locally

git clone https://github.com/catppuccin/gleam/

Cd to the codegen directory
```
cd codegen
```
Run the project to generate files
```
gleam run
```
Replace the generated files
```
mv -iv out/catppuccin.gleam ../src/
```

🏗️ CI/CD Release Workflow

Set the HEX_DEPLOY_KEY token in the repository secrets (Settings > Secrets > Actions).

💝 Thanks to

MAHcodes

3.5 KiB Raw Permalink Blame History