Documentation

Getting Started

Coolema is a curated collection of color schemas designed specifically for terminal emulators. Whether you're using Kitty, Alacritty, Foot, WezTerm, or another terminal, we've got you covered.

How to Use

1. Browse the schemas collection and find one you like
2. Click on a schema to view its details and color palette
3. Select your terminal emulator format from the export section
4. Copy the configuration or download the config file
5. Paste the configuration into your terminal's config file
6. Restart your terminal or reload the configuration

Terminal Setup

Contribution Guide

Coolema is open-source and welcomes contributions from the community. Here's how you can add your own color schema:

Adding a Schema

1. Fork the repository on GitHub
2. Create a new MDX file in content/schemas/ with your schema name (e.g., my-awesome-theme.mdx)
3. Add YAML frontmatter with the required fields (see example below)
4. Ensure you have at least 16 colors (color0 through color15)
5. Test your schema locally by running the development server
6. Submit a pull request with a clear description of your schema

Schema Template

---
title: 'My Awesome Theme'
description: 'A beautiful dark theme with warm colors'
author: 'Your Name'
tags: ['dark', 'warm', 'retro']
colors:
  - name: 'color0'
    hex: '#1a1b26'
    rgb: 'rgb(26, 27, 38)'
  - name: 'color1'
    hex: '#f7768e'
    rgb: 'rgb(247, 118, 142)'
  # ... add colors 2-15
---
Optional content about your theme goes here.

Guidelines

• Use descriptive names for your schema
• Provide accurate color values in both hex and RGB formats
• Include appropriate tags (dark, light, retro, modern, etc.)
• Test your schema in at least one terminal emulator
• Ensure proper contrast for readability
• Credit original authors if adapting existing themes

Supported Formats

Coolema currently supports the following terminal emulator formats: