Skip to content

catppuccin/sublime-text

Repository files navigation

Logo
Catppuccin for Sublime Text

Usage

Installation

Package Control

  1. In Sublime Text, open the command palette with Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
  2. Enter Package Control Install Package (or just pcip) and select it.
  3. Search for and select the Catppuccin package.

Git download

  1. In Sublime Text, locate the path to the Packages directory through the Preferences > Browse Packages... menu.
  2. From the command line, go to the previously noted directory path and clone the repository into it.
git clone https://github.com/catppuccin/sublime-text.git Catppuccin

Manual download

  1. Download this repository as a ZIP archive.
  2. Unzip into a directory named Catppuccin.
  3. In Sublime Text, open the Packages directory through the Preferences > Browse Packages... menu.
  4. Move the unzipped Catppuccin directory into the Packages directory.

Activation

  1. In Sublime Text, select your flavor of choice through Preferences > Select Color Scheme.
  2. Go to Preferences > Select Theme... and select Adaptive.

Development

Local modifications

If you're unfamiliar with Sublime Text color scheme development, see "Color Schemes" in the Sublime Text documentation.

For local editing, you can invoke UI: Customize Color Scheme in the command palette to open a split-pane window with the current color scheme on the left and an override file on the right. Rules you add to your override file will be processed after the rules in the official color scheme.

If you have a specific piece of code you would like to re-color, you'll need to know what scopes are being applied to the token. (Applying scopes is done by the syntax, not the color scheme.) Position your caret over the token, and use Ctrl+Shift+P (or Tools > Developer > Show Scope Name). Then add a rule in your color scheme override to apply a color to this token.

Contributing modifications

  1. Clone this repository and open it
  2. Apply your changes to sublime-color-scheme.tera
  3. Re-build the 4 flavors with whiskers sublime-color-scheme.tera
  4. To install Whiskers, the Catppuccin helper tool, see https://github.com/catppuccin/whiskers
  5. Open a Pull Request!

💝 Thanks to

 

Copyright © 2021-present Catppuccin Org