Skip to content

Commit

Permalink
lint: trunk fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
elvis kahoro committed Oct 24, 2022
1 parent 3de1620 commit 892e438
Show file tree
Hide file tree
Showing 276 changed files with 5,432 additions and 5,639 deletions.
11 changes: 6 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Discord username (optional)

If you're in our Discord server, we'd like to give you the Contributor Discord Role, please include your username.
Note: It must be labelled like so: username#4747 (make sure to include the #XXXX).
If you're in our Discord server, we'd like to give you the Contributor Discord Role, please include
your username. Note: It must be labelled like so: username#4747 (make sure to include the #XXXX).

## Name of theme

Expand All @@ -17,7 +17,8 @@ Have you run the python script? `python3 ./scripts/gen_theme_previews.py <folder

We cannot accept pull request that include custom background images because:

* of licensing restrictions
* we are trying to keep the binary size of the repo as small as possible (just the yaml files)
- of licensing restrictions
- we are trying to keep the binary size of the repo as small as possible (just the yaml files)

If your theme has an intended custom background image, include a comment in the yaml with a link to where people should download it.
If your theme has an intended custom background image, include a comment in the yaml with a link to
where people should download it.
60 changes: 36 additions & 24 deletions README-intro.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# Warp Themes

This is an open source repository with themes for [Warp](https://www.warp.dev/).
We welcome and appreciate any contributions!
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
This is an open source repository with themes for [Warp](https://www.warp.dev/). We welcome and
appreciate any contributions! Join our [Discord](https://discord.gg/warpdotdev), we have a channel
dedicated to discussing custom themes.

We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
We have
[directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)

## Custom Background Images

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

* a relative path to `~/.warp/themes`
* the absolute path to the background image
- a relative path to `~/.warp/themes`
- the absolute path to the background image

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

```yaml
background_image:
Expand All @@ -22,38 +25,47 @@ background_image:
## Contributing
tldr; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
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`
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.](https://docs.warp.dev/features/themes).
There are more
[directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).

## 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:
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)
* [base16](https://github.com/chriskempson/base16)
* [Solarized](https://ethanschoonover.com/solarized/)
* [Dracula](https://draculatheme.com/)
* [Gruvbox](https://github.com/morhetz/gruvbox)
- [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)
- [base16](https://github.com/chriskempson/base16)
- [Solarized](https://ethanschoonover.com/solarized/)
- [Dracula](https://draculatheme.com/)
- [Gruvbox](https://github.com/morhetz/gruvbox)

## 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.
> 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.](https://github.com/chriskempson/base16)
More on the details and structure here:
[https://github.com/chriskempson/base16.](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](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.
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](https://github.com/eendroroy/alacritty-theme)
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by
@eendroroy. Repo:
[https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)
54 changes: 35 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# Warp Themes

This is an open-source repository with themes for [Warp](https://www.warp.dev/).
We welcome and appreciate any contributions!
Join our [Discord](https://discord.gg/warpdotdev), we have a channel dedicated to discussing custom themes.
This is an open-source repository with themes for [Warp](https://www.warp.dev/). We welcome and
appreciate any contributions! Join our [Discord](https://discord.gg/warpdotdev), we have a channel
dedicated to discussing custom themes.

We have [directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)
We have
[directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes)

## Custom Background Images

Warp supports setting background images, set the path to your background image in your themes `.yaml` file:
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`
- 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:
If your background image was under `~/.warp/themes/level_one/level_two/background_image.jpg` then
the file path in the yaml should be:

```yaml
background_image:
Expand All @@ -23,17 +26,21 @@ background_image:
## Contributing
TLDR; After adding your theme run the python script for generating theme previews `./scripts/gen_theme_previews.py` like so:
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`
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.](https://docs.warp.dev/features/themes).
There are more
[directions on how to use this repository in our documentation.](https://docs.warp.dev/features/themes).

## 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:
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)
Expand All @@ -45,19 +52,24 @@ We'd like to call out a few of the open source themes and repositories that help

## 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.
> 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.](https://github.com/chriskempson/base16)
More on the details and structure here:
[https://github.com/chriskempson/base16.](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](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.
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](https://github.com/eendroroy/alacritty-theme)
Themes in this directory were sourced and auto-generated based on the Alacritty themes collected by
@eendroroy. Repo:
[https://github.com/eendroroy/alacritty-theme](https://github.com/eendroroy/alacritty-theme)

## What are holiday themes?

Expand All @@ -68,5 +80,9 @@ We made holiday themes to celebrate various holidays during the calendar year.
These are the themes that ship directly with Warp.

## Create your own theme with Warp-Themes.com

[Warp-Themes.com](https://warp-themes.com/) is a web app built entirely by community member [Torben Haack](https://twitter.com/torben_haack). The tool allows you to visually customize your own terminal theme with a few simple color selections, then download that theme file and have Warp load it into its theme picker. Please see more on how to use the app in our [Warp-Themes blog post](https://www.warp.dev/blog/create-custom-terminal-theme).

[Warp-Themes.com](https://warp-themes.com/) is a web app built entirely by community member
[Torben Haack](https://twitter.com/torben_haack). The tool allows you to visually customize your own
terminal theme with a few simple color selections, then download that theme file and have Warp load
it into its theme picker. Please see more on how to use the app in our
[Warp-Themes blog post](https://www.warp.dev/blog/create-custom-terminal-theme).
Loading

0 comments on commit 892e438

Please sign in to comment.