Skip to content

Latest commit

 

History

History
64 lines (38 loc) · 3.02 KB

README.md

File metadata and controls

64 lines (38 loc) · 3.02 KB
Raw

Warp Themes

This is an open-source repository with themes for Warp. We welcome and appreciate any contributions! Join our Discord, we have a channel dedicated to discussing custom themes.

We have directions on how to use this repository in our documentation.

Custom Background Images

Warp supports setting background images, set the path to your background image in your themes .yaml file:

  • A relative path to ~/.warp/themes/background.jpg
  • The absolute path to the background image /Users/my_user/Documents/background.jpg

If your background image was under ~/.warp/themes/level_one/level_two/background_image.jpg then the file path in the yaml should be:

background_image:
  # background image credit: https://unsplash.com/photos/0eKCOZ11gfk
  path: "level_one/level_two/background_image.jpg"

Contributing

TLDR; After adding your theme run the python script for generating theme previews ./scripts/gen_theme_previews.py like so:

python3 ./scripts/gen_theme_previews.py standard

for a newly added theme that's in the standard folder/directory. If you get the error that yaml is missing make sure you pip install PyYAML

There are more directions on how to use this repository in our documentation..

Open source dependencies

We'd like to call out a few of the open source themes and repositories that helped bootstrap the set of themes for Warp:

What are base16 themes?

An architecture for building themes based on carefully chosen syntax highlighting using a base of sixteen colors. Base16 provides a set of guidelines detailing how to style syntax and how to code a builder for compiling Base16 schemes and templates.

More on the details and structure here: https://github.com/chriskempson/base16.

Base16 themes were sourced and auto-generated based on the Alacritty themes collected by @aarowill. Repo: https://github.com/aarowill/base16-alacritty

What are standard themes?

In this directory, you'll find themes popular among other tools, including Solarized, Dracula, and others.

Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by @eendroroy. Repo: https://github.com/eendroroy/alacritty-theme

What are holiday themes?

We made holiday themes to celebrate various holidays during the calendar year.

What are warp_bundled themes?

These are the themes that ship directly with Warp.