#
Theme variables
This reference documents all available customizable theme
variables that can be added to your retype.yml
file. Each variable can be overridden in both base
(light mode) and dark
(dark mode) configurations.
The following demonstrates a basic configuration where the base-color
and background color are configured with custom values:
theme:
base:
base-color: "#8839ef"
base-bg: "#eff1f5"
dark:
base-color: "#ca9ee6"
base-bg: "#303446"
#
Base
Core variables that define the fundamental appearance of your site.
#
Variants
Semantic color variants are used throughout Retype components. These colors provide consistent theming for different types of content and actions. Each variant is available as a full color palette from 50
(lightest) to 900
(darkest).
#
Color Palettes
System elements and base
variants for Components are derived from the base-color
using the base
color palette.
#
Base
Color variations based on your base-color
setting:
#
Semantic Color Palettes
Each semantic color includes shades from 50
(lightest) to 900
(darkest):
The semantic color shades follow a consistent pattern where:
- Lower numbers (50-400) are lighter shades created by mixing with white
- Higher numbers (600-900) are darker shades created by mixing with black
- The mid color
500
of each sequence represents the pure color for that sequence
#
Primary
Semantic palette primary
with shades 50
through 900
:
#
Success
Semantic palette success
with shades 50
through 900
:
#
Danger
Semantic palette danger
with shades 50
through 900
:
#
Warning
Semantic palette warning
with shades 50
through 900
:
#
Royal
Semantic palette royal
with shades 50
through 900
#
Gray
Predefined gray color variations:
#
Dark
Specialized dark mode color variations:
#
Helper
Utility variables used throughout the theme system.
#
Branding
Variables for customizing branding elements.
#
Header
Variables controlling the header appearance.
#
Search
Variables for customizing search functionality appearance.
#
Filter
Variables for customizing filter functionality.
#
Body
Variables controlling the main content area.
#
Heading
Variables for heading text styling.
#
Scheme
Variables for the Light/Dark switcher component.
#
Sidebar
Variables controlling the left and right sidebars.
#
Navigation
Variables for customizing navigation appearance and behavior.
#
Table of Contents
Variables controlling the Table of Contents appearance in the right sidebar.
#
Footer
Variables controlling the footer appearance.
#
Badge Component
Variables for customizing badge components across all variants.
#
Base Badge
#
Primary Badge
#
Secondary Badge
#
Success Badge
#
Danger Badge
#
Warning Badge
#
Info Badge
#
Light Badge
#
Dark Badge
#
Ghost Badge
#
Contrast Badge
#
Button Component
Variables for customizing button components across all variants.
#
Base Button
#
Primary Button
#
Secondary Button
#
Success Button
#
Danger Button
#
Warning Button
#
Info Button
#
Light Button
#
Dark Button
#
Ghost Button
#
Contrast Button
#
Callout Component
Variables for customizing callout components.
#
Base Callout
#
Callout Accent Colors
#
Image Component
Variables for customizing image appearance.
#
List Component
Variables for customizing list appearance.
#
Tab Component
Variables for customizing tab appearance.