Options

Every option the plugin takes.

starlightThemeHypha({
  palette: "catppuccin",
  scheme: "auto",
  brand: "acme",
  github: "acme/widgets",
  tabs: { Guides: "book-open", Reference: "file-text" },
  links: [{ label: "Changelog", href: "/changelog/", icon: "scroll-text" }],
});

All are optional. The plugin refuses an option it does not know the shape of and names it.

Colours

Option	Type	Default	Description
`palette`	`string`	`"hypha"`	The colours, dark and light, with code themes to match: `hypha`, `catppuccin`, `rose-pine`, `gruvbox`, `everforest`, `kanagawa`, `solarized`, `github`, `night-owl`, `vitesse`
`hue`	`number`, 0 to 360	`225`	`hypha` only: the near-greys’ hue. Alone, the accent follows it
`accent`	`number`, 0 to 360	`231`	`hypha` only: the accent’s hue
`tint`	`number`, 0 to 2	`1`	`hypha` only: how much colour the greys carry; 0 is grey
`scheme`	`"auto" \| "dark" \| "light"`	`"auto"`	The scheme a visit starts in; `auto` follows the visitor’s system
`themeSelect`	`boolean`	`true`	The header’s control, for the visitor to change the scheme

See Colours.

The header

Option	Type	Default	Description
`brand`	`string`	none	Before the title: `"acme"` with the title `"docs"` reads `acme.docs`
`search`	`boolean`	`true`	Search in the header; `false` turns off Pagefind too
`github`	`string`, or `{ repo; stats }`	none	The repository, `owner/name`, with its version, stars and forks
`tabs`	`boolean`, or an icon by label	`false`	The sidebar’s top-level groups as tabs under the header
`links`	`{ label; href; icon? }[]`	`[]`	Links after the tabs; one to another site opens in a new tab

See The header.

Icons

A tab, a link and a feature take an icon by its name: any of Lucide’s, as lucide.dev names it, or starlight, Starlight’s own mark. Any other name stops the build.

starlightThemeHypha({
  tabs: { Guides: "compass" },
  links: [{ label: "Changelog", href: "/changelog/", icon: "scroll-text" }],
});