Skip to content

catppuccin/zed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo
Catppuccin for Zed

Previews

🌻 Latte
🪴 Frappé
🌺 Macchiato
🌿 Mocha

Usage

Install via Zed Extensions

  1. Open Zed.
  2. cmd+shift+p and select zed: extensions
  3. Select Catppuccin Themes and Install
  4. Select your Catppuccin theme in the dropdown shown after hitting cmd+k, cmd+t

🎨 Install Different Accents

  1. Download accent.json from GH Releases
  2. mkdir -p ~/.config/zed/themes/
  3. Move the accent.json file to ~/.config/zed/themes/
  4. Restart Zed
  5. Select the chosen theme in the dropdown shown after hitting cmd+k, cmd+t

Development

Use whiskers to Render Theme from zed.tera Template

  1. Install Rust

  2. Install whiskers (>= 2.0.2)

    # from source (preferred)
    cargo install --git https://github.com/catppuccin/toolbox catppuccin-whiskers
  3. Test and check changes against current themes/catppuccin.json theme

    # returns nothing if OK
    whiskers zed.tera -o json --overrides '{"accent": "mauve"}' --check themes/catppuccin-mauve.json
  4. Build the zed extension .json theme file (mauve accent only)

    whiskers zed.tera -o json --overrides '{"accent": "mauve"}'
  5. (Optional) 🎨 Generate all accents per Flavor

    whiskers zed.tera -o json
  6. Refresh Zed to load changes after ensuring local extension install

Test Zed Extension Theme Locally

From Zed Extensions docs:

  1. Install project as "Zed Dev Extension"
cmd+shift+p > zed: install dev extension > (select current directory)
  1. Refresh theme extension using: cmd+shift+p > zed: reload extensions
  2. (Optional) zed: restart workspace may be needed if changes are not reflected immediately

Publishing to Zed Extensions Marketplace

Zed organizes all extensions using git submodules in the zed/extensions repo.

  1. Fork the repo

  2. Pull the currently published extensions/catppuccin/ submodule

    git submodule update --init --force extensions/catppuccin
    
  3. Bump catppuccin submodule

    cd extensions/catppuccin/ && git pull origin main
    
  4. Modify the extensions/extensions.toml version to match value in catpuccin/zed/extension.toml

  5. Submit a PR to merge back to zed/extensions

💝 Thanks to

 

Copyright © 2021-present Catppuccin Org