# Pote v3.0.0 - Table of Contents

> Colorimetry and theme/palette management library for Elixir - parse, convert, harmonize, and render colors across multiple color spaces.

## Pages

- [README](readme.md)
- [README.es](readme-es.md)
- [MIT License](license.md)

## Modules

- [Pote.Theme.Theme](Pote.Theme.Theme.md): The theme struct — name, optional description, and the colour map.

- Core
  - [Pote](Pote.md): Pote — canonical color types, default palette, and top-level helpers.
  - [Pote.ColorInfo](Pote.ColorInfo.md): Structured representation of a color in all supported formats.
  - [Pote.Error](Pote.Error.md): Typed error returned by Pote APIs that parse or validate structured
input (currently theme JSON loading).

- Converters
  - [Pote.Converters](Pote.Converters.md): Color conversion module.
  - [Pote.Converters.Advanced](Pote.Converters.Advanced.md): Advanced color conversions for special color spaces.
  - [Pote.Converters.CMYK](Pote.Converters.CMYK.md): Conversions to/from CMYK.

  - [Pote.Converters.HSL](Pote.Converters.HSL.md): Conversions to/from HSL.

  - [Pote.Converters.HSV](Pote.Converters.HSV.md): Conversions to/from HSV.

  - [Pote.Converters.HWB](Pote.Converters.HWB.md): Conversions to/from HWB (Hue, Whiteness, Blackness).

  - [Pote.Converters.RGB](Pote.Converters.RGB.md): Conversions to/from RGB.
  - [Pote.Converters.XTerm256](Pote.Converters.XTerm256.md): Conversions to/from XTerm256.

- Color Formats
  - [Pote.Format](Pote.Format.md): Behaviour for color format handlers.
  - [Pote.Format.ARGB](Pote.Format.ARGB.md): ARGB format for colours ({a, r, g, b}).

  - [Pote.Format.Atom](Pote.Format.Atom.md): Atom format for colours by name.
  - [Pote.Format.CMYK](Pote.Format.CMYK.md): CMYK format for colours ({c, m, y, k}).
All values: 0-100 (%)

  - [Pote.Format.HSL](Pote.Format.HSL.md): HSL format for colours ({h, s, l}).
h: 0-360 (degrees), s: 0-100 (%), l: 0-100 (%)

  - [Pote.Format.HSV](Pote.Format.HSV.md): HSV format for colours ({h, s, v}).
h: 0-360 (degrees), s: 0-100 (%), v: 0-100 (%)

  - [Pote.Format.Hex](Pote.Format.Hex.md): Hex format for colours (#RRGGBB).
  - [Pote.Format.RGB](Pote.Format.RGB.md): RGB format for colours ({r, g, b}).
  - [Pote.Format.XTerm256](Pote.Format.XTerm256.md): XTerm256 format for colours (0-255).

- Harmonies
  - [Pote.Colors.Basic](Pote.Colors.Basic.md): Unified map of basic color names to RGB values.
  - [Pote.Harmonies](Pote.Harmonies.md): Color harmony generation based on color theory principles.

- Gradients
  - [Pote.Gradients](Pote.Gradients.md): Linear and multi-stop color gradient generation.

- Style
  - [Pote.Palette](Pote.Palette.md): Procedural palette generation.
  - [Pote.Style](Pote.Style.md): Inline styling DSL — compose foreground, background and text effects
into an immutable `%Pote.Style{}` struct, then render text with ANSI
escapes.

- Validation
  - [Pote.Sanitizer](Pote.Sanitizer.md): Handles cleaning user input for colour formats.
  - [Pote.Validator](Pote.Validator.md): Validates color format values against their specification.
  - [Pote.Validator.Bracket](Pote.Validator.Bracket.md): Bracket-style detection for color format strings.
  - [Pote.Validator.CMYK](Pote.Validator.CMYK.md): CMYK color string validation.
  - [Pote.Validator.HSL](Pote.Validator.HSL.md): HSL and HSV color string validation.
  - [Pote.Validator.HWB](Pote.Validator.HWB.md): HWB (Hue-Whiteness-Blackness) color string validation.
  - [Pote.Validator.Hex](Pote.Validator.Hex.md): Hex color string validation.
  - [Pote.Validator.Parser](Pote.Validator.Parser.md): Internal parser helpers used by `Pote.Validator`.
  - [Pote.Validator.RGB](Pote.Validator.RGB.md): RGB and ARGB color string validation.
  - [Pote.Validator.Theme](Pote.Validator.Theme.md): Theme color name validation.
  - [Pote.Validator.XTerm](Pote.Validator.XTerm.md): XTerm256 color index validation.

- Orchestration
  - [Pote.Orchestrator](Pote.Orchestrator.md): Color orchestration module for parsing, converting, and formatting colors.
  - [Pote.Orchestrator.Parser](Pote.Orchestrator.Parser.md): Parses color inputs from various formats into normalized RGB tuples.

- Accessibility
  - [Pote.Accessibility](Pote.Accessibility.md): Color-blindness simulation helpers.

- Themes
  - [Pote.Theme](Pote.Theme.md): A theme system that any host application can opt into.
  - [Pote.Theme.Runtime](Pote.Theme.Runtime.md): Runtime theme operations for host modules using `Pote.Theme`.
  - [Pote.Theme.Templates](Pote.Theme.Templates.md): Built-in theme templates that ship with Pote.

