Srcery Logo Glyph Daniel Berg 2023 Daniel Berg and srcery-colors contributors

Srcery

This is a collection Srcery resources to get you started developing a theme. In addition to themes, Srcery has some tools and packages that aid in creating new themes, documentation, and or other related etcetera.

The palette repository and accompanying npm package contains the up-to-date palette used in the Srcery ports. To get started install the package using npm or git:

npm i @srcery-colors/srcery-palette
git clone https://github.com/srcery-colors/srcery-palette

Once downloaded, you can access the colors however you prefer. Here I use jq to grab red from the json palette in bash:

jq < palette.json '.primary.red.hex'
Or if you use the npm package, it exports palette.json, making it available in javascript like this:
import palette from "@srcery-colors/srcery-palette"; console.log(palette.primary.red.hex);
The package also exports CSS variables that can be imported in your CSS files
@import "@srcery-colors/srcery-palette"; background: var(--srcery-palette-primary-black);

No formal design guidelines exist, but a good reference point is the Vim theme, or pick your favorite port and follow that. This website also gives some idea of which colors goes where.

For UI elements, the gray shades, black, and white are very useful, while the 16 base colors work well as accents for important information.

We keep graphic assets in a separate repo so not to inflate the size of each theme. If you are looking for icons, logo, screenshots, etcetera, this is the place. All assets are under a permissive license for easy distribution.