Skip to content

Commit

Permalink
lint markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
elviskahoro committed Dec 7, 2021
1 parent 9333ee9 commit c793314
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,15 @@ The main difference between "standard" and "base16" themes is that "standard" th
Some of the standard themes have their "base16" version available in the repo as well.

To install a theme from this repo you can:

- download just a single file and follow the steps from (1)
- clone the entire repo and run `mv <your_clone_location>standard/* ~/.warp/themes && mv <your_clone_location>base16/* ~/.warp/themes` to use all of the available themes

## 3. How do I write my own custom theme?

A custom theme in Warp has the following yml structure:

```
```yaml
# Accent color for UI elements
accent: '#268bd2'
# Terminal background color
Expand Down Expand Up @@ -124,27 +126,29 @@ terminal_colors:
white: '#eee8d5'
yellow: '#b58900'
```

### Gradients

To set up a gradient, instead of using a single accent or background value ('#268bd2' in example above).
You can create a sub-level (one indention) with two sub-values either "left" and "right" for horizontal gradients or "top" and "bottom" for vertical gradients.
Like so:

```
```yaml
accent:
top: #abcdef
bottom: #fedcba
```

```
```yaml
accent:
left: #abcdef
right: #fedcba
```

You can also do this for backgrounds.
Here's a full yaml file with gradients set for both background and accent:
Here's a full yaml file with gradients set for both background and accent:

```
```yaml
################################ See below
# accent has a gradient
accent:
Expand Down Expand Up @@ -182,32 +186,40 @@ terminal_colors:
```

## 5. Contributing

Feeling like your designer wants to share your own take on Warp theming? Any contributions to this repo are greatly appreciated - help us spread the ♥ of Warp!

1. Fork the project
2. Create your branch (`git checkout -b theme/AwesomeTheme`)
3. Regenerate thumbnails:
```
1: Fork the project
2: Create your branch (`git checkout -b theme/AwesomeTheme`)
3: Regenerate thumbnails:

```sh
# assuming you're adding the theme to `standard` directory:
python3 ./scripts/gen_theme_previews.py standard/ standard/ ./scripts/preview.svg ./standard/README.md-intro
```
4. Commit your changes (`git commit -m 'This theme is awesome'`)
5. Push to the branch (`git push origin`)
6. Open a pull request

4: Commit your changes (`git commit -m 'This theme is awesome'`)
5: Push to the branch (`git push origin`)
6: Open a pull request

## 5. Contact & more Warp information

Have feedback or suggestion for this repo? Please, file an issue.

All other Warp-related things can be discussed in [Warp official repo](https://github.com/warpdotdev/warp) or our [Discord server](https://discord.gg/T2p5xFgpjr).

## 6. FAQ

Frequently Asked Questions

### Is this a final format for the configuration?

The format itself will expand but we don't forsee any breaking changes to current themes. We also plan on supporting sharing/creating custom themes directly within Warp.

## 7. 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:

- [iTerm colors pencil](https://github.com/mattly/iterm-colors-pencil)
- [Alacritty-theme](https://github.com/eendroroy/alacritty-theme)
- [base16-Alacritty](https://github.com/aarowill/base16-alacritty)
Expand Down

0 comments on commit c793314

Please sign in to comment.