An open API service indexing awesome lists of open source software.

https://github.com/CptPotato/helix-themes

A few themes for the helix editor
https://github.com/CptPotato/helix-themes

Last synced: 14 days ago
JSON representation

A few themes for the helix editor

Awesome Lists containing this project

README

          


header

## Helix Themes

A few themes for the [helix editor](https://github.com/helix-editor/helix). Most of them are direct ports of existing themes.

The included themes generally follow these rules:

- Medium contrast and saturation
- Balanced use of different colors (easily discernable syntax)
- Not too many colors

***For preview images see: [PREVIEWS.md](PREVIEWS.md)***

### Included themes

- [Edge](PREVIEWS.md#edge)
- Port of [`sainnhe/edge`](https://github.com/sainnhe/edge) ([MIT](https://github.com/sainnhe/edge/blob/master/LICENSE))
- [Everforest](PREVIEWS.md#everforest-dark)
- Port of [`sainnhe/everforest`](https://github.com/sainnhe/everforest) ([MIT](https://github.com/sainnhe/everforest/blob/master/LICENSE))
- Added customized high contrast version
- [Gruvbox Material](PREVIEWS.md#gruvbox-dark)
- Port of [`sainnhe/gruvbox-material`](https://github.com/sainnhe/gruvbox-material) ([MIT](https://github.com/sainnhe/gruvbox-material/blob/master/LICENSE))
- Includes `material`, `mix` and `original` variants
- [Kanabox](PREVIEWS.md#kanabox)
- Experimental mashup of [Kanagawa](https://github.com/rebelot/kanagawa.nvim) ([MIT](https://github.com/rebelot/kanagawa.nvim/blob/master/LICENSE)) and [Gruvbox Material](https://github.com/sainnhe/gruvbox-material) ([MIT](https://github.com/sainnhe/gruvbox-material/blob/master/LICENSE))
- [Sonokai](PREVIEWS.md#sonokai)
- Port of [`sainnhe/sonokai`](https://github.com/sainnhe/sonokai) ([MIT](https://github.com/sainnhe/sonokai/blob/master/LICENSE))

### Download

The latest build of the `main` branch can be downloaded from the GitHub releases page [here](https://github.com/CptPotato/helix-themes/releases/tag/latest).

> The release date and commit on the releases page point to an old version. However, `build.tar.gz` is always up to date.

### Installation

User themes can be added to the `themes` subdirectory of the config location (for example `~/.config/helix/themes` on Linux, or `C:/Users//AppData/Roaming/helix/themes` on Windows).
To "install" a theme simply copy it into that directory (you may have to create it if it doesn't exist yet). Alternatively you can symlink the whole `themes` directory.

If you are unsure where the config path is located on your machine, run `hx --health` and look for `Config file: ...` at the top. You can read more about themes in the Helix docs [here](https://docs.helix-editor.com/themes.html).

### Home Manager Module

Nix users can either use the flake overlay to add the package to their package set, then use home-manager to
symlink the directory to their helix theme directory as described in [installation](#installation), or use the
home-manager module from the flake which automatically sets [`programs.helix.themes`](https://nix-community.github.io/home-manager/options.xhtml#opt-programs.helix.themes) if helix is enabled.

### Building manually

Themes are split into a color scheme or "mapping" ("constants are purple") and one or more palettes ("purple is `#b39df3`").
Each theme is built by simply merging the [scheme](schemes) with one of the corresponding [palettes](palettes).

You can generate all themes by running `build.sh` from the root of the repository.

Or just generate a single one:

```bash
cat "schemes/gruvbox" "palettes/gruvbox/material_dark_medium" > "theme.toml"
```

On Windows you can run the shell script (or `cat` command above) from the git bash that comes with git or use the executable directly (`/usr/bin/sh.exe build.sh`).