Repository navigation
Configuration Reference
StarryBio reads one strict TypeScript object from config/starrybio.config.ts. End the object with satisfies StarryBioConfig; this keeps editor type checking while the same schema validates the configuration during pnpm validate, pnpm dev, and pnpm build.
import type { StarryBioConfig } from '../src/config/schema';
const config = {
// configuration
} satisfies StarryBioConfig;
export default config;| Setting | Required | Purpose | Default when omitted |
|---|---|---|---|
pageTitle |
Yes | Browser tab title and fallback SEO title. | None |
favicon |
No | Local public/ asset or HTTP(S) favicon URL. |
No favicon link emitted |
profile |
Yes | The profile name, description, image, and optional image/text layout. | None |
sections |
Yes | Ordered groups of profile links. | None |
featured |
No | Prominent link cards. | [] |
theme |
No | Preset name or visual settings object. |
midnight-based defaults |
layout |
No | Card, grid, link, and featured-card placement. | Centered/card defaults |
animation |
No | Star and shooting-star multipliers. | Both 1
|
status |
No | Client-side availability indicator and schedule dialog. | Not rendered |
announcement |
No | Dismissible site-wide notice. | Not rendered |
seo |
No | Description, canonical URL, sharing image, and theme color. | Derived from page/profile/theme |
ogImage |
No | Build-time social image generator. | Disabled |
qr |
No | Build-time downloadable QR generator. | Disabled |
analytics |
No | One supported external analytics provider. | { provider: 'none' } |
contactCard |
No | Build-time downloadable vCard generator. | Disabled |
footer |
No | Custom copyright text. | © <current year> StarryBio |
The pages linked below explain the behavior of each group. This page records the contract and exact fallback values.
{
pageTitle: 'Ada Lovelace',
favicon: 'assets/images/favicon.svg',
profile: {
name: 'Ada Lovelace',
description: 'Mathematician and programmer.',
image: 'assets/images/profile.svg',
layout: 'vertical', // optional: 'vertical' or 'horizontal'
},
sections: [],
}profile.name, profile.description, and profile.image must be non-empty. A local image path may be written as assets/images/profile.svg or /assets/images/profile.svg; both resolve under public/. An image may instead be an HTTP(S) URL. See Assets and Generated Downloads.
theme can be a preset string, such as theme: 'aurora', or an object. The supported preset values are nebula, midnight, classic-blue, aurora, eclipse, cosmic-gold, minimal, and terminal.
theme: {
preset: 'midnight',
accent: '#7ddf9b', // optional #RGB, #RRGGBB, or #RRGGBBAA
mode: 'dark', // 'dark' or 'light'
buttonStyle: 'glass', // glass, solid, outline, minimal, terminal
background: 'starfield', // starfield, gradient, minimal
animationIntensity: 'normal', // none, subtle, normal, high
},
layout: {
mode: 'centered', // see Appearance and Branding
linkStyle: 'cards', // cards, buttons, minimal, terminal
profilePosition: 'top', // top or left
featuredPosition: 'above-links', // above-links or below-links
},
animation: {
starMultiplier: 1,
shootingStarMultiplier: 1,
},If theme is absent, defaults are midnight, dark mode, glass buttons, starfield background, and normal intensity. The minimal preset defaults to light mode and a minimal background; the terminal preset defaults to terminal button style and terminal layout. Other layout defaults are centered, cards, top, and above-links.
Both multipliers must be numbers greater than or equal to zero. 0 disables that effect. The visitor’s reduced-motion preference also stops nonessential animated movement, regardless of the chosen intensity.
See Appearance and Branding for practical combinations and current layout behavior.
Sections, individual links, and featured cards can each use these optional fields:
{
enabled: true,
visibleFrom: '2026-10-01T09:00:00Z',
visibleUntil: '2026-11-01T00:00:00Z',
}enabled: false hides the item. The timestamp format must be an ISO date-time with a time component. visibleFrom is inclusive; visibleUntil is exclusive and must be later than visibleFrom. Visibility is evaluated when the site is built, not by each visitor. A timed campaign will not appear or disappear on an already deployed static site until the next build and deployment.
- Link destinations accept HTTP(S),
mailto:,tel:, root-relative paths, normal relative paths, and—where allowed—hash links.javascript:and protocol-relative URLs are rejected. - Featured-card URLs do not accept a hash target. Link and announcement URLs do.
- Asset URLs must be HTTP(S) or a safe path under
public/; parent traversal is rejected. - Generated output must stay under
public/. OG and QR outputs must end in.pngor.svg; vCards must end in.vcf. - Every object is strict. Misspelling a field produces a validation error rather than silently doing nothing.
-
Managing Content covers
sections,links,featured, icons, and scheduled visibility. -
Availability and Announcements covers
statusandannouncement. -
Assets and Generated Downloads covers
favicon, local assets,ogImage,qr, andcontactCard. -
SEO and Analytics covers
seoandanalytics. -
Appearance and Branding covers
theme,layout,animation, andfooter.
There are no StarryBio configuration environment variables. Keep operating configuration in this file and do not place credentials in it.
StarryBio · 🏠 Home · ✨ Configure · 🚀 Deploy · 🩺 Troubleshoot · 🛠 Developer guide
Static link-in-bio setup, operation, and development guides.
- Configuration Reference
- Managing Content
- Appearance and Branding
- Availability and Announcements
- Assets and Generated Downloads
- SEO and Analytics