Skip to content

Creating Userstyles

To create a userstyle, follow the instructions below. If you are unsure how to theme something, see our Guides. If you run into any difficulties or have any questions, feel free to join the Catppuccin Discord server and find us in the #userstyles channel!

  1. Fork the catppuccin/userstyles repository.
  2. Create a new branch under the name feat/<name-of-website>, (e.g. feat/nixos-search instead of NixOS Search).
  3. Create a new folder styles/<name-of-website>. The name must be lower-kebab-case.
  4. Copy the contents of the template folder into styles/<name-of-website>.
    • The template uses LESS, a preprocessor for Stylus. Please do not change this as we will only accept userstyles based on the template.
  5. Write the userstyle.
  6. Edit the userstyles.yml file and enter the details of your port.
  7. Raise a pull request, making sure to read and fill out the template properly. The title of your pull request should follow the format of feat(<name-of-website>): init.