CM-Colors

CM-Colors#

Automated Color Contrast Tuning for Accessibility

CM-Colors is a library and CLI tool that automatically adjusts color pairs in your CSS to meet WCAG accessibility standards. It uses the OKLCH color space to preserve the visual intent of your design while ensuring readability.

Quickstart

Get up and running with CM-Colors in 5 minutes. Learn how to install and tune your first CSS file.

Quickstart
How-to Guides

Step-by-step guides for integrating CM-Colors into your workflow, CI/CD pipelines, and more.

How-to Guides
Reference

Detailed API and CLI documentation for developers and power users.

CLI Tool
Explanation

Deep dive into the concepts behind color spaces, accessibility standards (WCAG), and our tuning algorithms.

Explanation

Choosing the Right API#

CM-Colors provides multiple ways to interact with its functionality. Choose the one that best fits your needs:

  • Working with a Color Pair? Use ColorPair Class. Ideal for checking contrast, tuning colors, and validating accessibility for a specific foreground/background combination.

  • Working with a Single Color? Use Color Class. Best for parsing, converting formats (Hex to RGB, etc.), and validating individual color values.

  • Need a Standalone Utility? Use CMColors Utility Class (CMColors). A functional interface for quick calculations or if you prefer not to instantiate objects.

Contents