Skip to content

Plugin Options

Named fallback presets for primary color roles. If seed is provided, seed takes precedence over accent.

Value Intent
teal Default green-teal Material You docs palette
purple Canonical Material 3 style accent for purple-led sites
blue Technical and product documentation
green Knowledge bases, operations, and sustainability themes
orange Warm editorial or tutorial sites
rose Expressive community or product documentation

Named option bundles for common documentation moods. Explicit options override the preset values.

Value Defaults Use case
neutral seed: '#607d8b', variant: 'content', shape: 'small' Quiet reference docs
playful seed: '#6750a4', variant: 'expressive', shape: 'large' Product and community docs
highContrast seed: '#005a54', variant: 'content', tonalSurface: false, shape: 'small', contrast: 'high' Dense operational docs

Generates light and dark Material-style color roles from a single hex color. Accepts #rgb or #rrggbb.

md3Theme({
seed: '#00a99d',
});

Seed roles are generated with @material/material-color-utilities during Astro configuration. tonalSpot and content use Material core palettes directly; expressive currently uses a HCT-based approximation while newer DynamicScheme entrypoints remain unstable in the target Node and bundler matrix.

Controls how the seed color is interpreted.

Value Use case
tonalSpot Calm default docs palette with restrained secondary and tertiary roles
expressive More hue separation for product or community documentation
content Roles stay closer to the seed color for branded documentation

Controls spacing tokens used by navigation, content rhythm, cards, and controls.

Value Use case
compact Default for dense docs and wiki-style sites
comfortable Better for tutorial-heavy docs with more breathing room

Controls the Material corner token scale.

Value Use case
small Conservative docs that should feel closer to stock Starlight
medium Default Material Design 3 inspired shape scale
large More expressive Material You presentation

Controls CSS-level state, outline, and selected-tone emphasis without relying on unstable DynamicScheme entrypoints.

Value Use case
standard Default balance for long-form documentation
medium Stronger focus, pressed, and outline states while keeping tonal selected containers
high Strongest state opacity and primary filled selected states for dense operational docs

When true, navigation, cards, code, and asides use layered tonal containers. When false, elevated surfaces flatten closer to the base surface color.

When true, tokenized state layers, pointer-origin ripple feedback, focus transitions, sidebar disclosure motion, TOC tracker motion, menu/search dialog surface transitions, homepage hero entrance motion, and content-only same-site route transitions are enabled for high-impact interactive surfaces. When false, the interactive motion runtime is skipped and theme transition duration tokens are set to 0ms.

The CSS also respects prefers-reduced-motion: reduce, so users who request reduced motion do not need a separate Starlight configuration.

Currently disabled. The current release keeps component overrides out of the public API and focuses on CSS-first styling.