Jerbix

Website Config

Every websiteConfig field and what its switches mean

Last updated October 29, 2026

src/config/website.ts is the single entry point for site configuration and exports the websiteConfig object. Name, logo, switches, and social links all live here.

ts
// src/config/website.ts
export function createWebsiteConfig(env: PublicEnv): WebsiteConfig {
  return {
    baseUrl: env.VITE_BASE_URL,
    metadata: { name: '<your-site-name>', images: { /* … */ } },
    ui: { defaultTheme: 'system', enableThemeSwitch: true, themeColor: { /* … */ } },
    docs: { enabled: true },
    // …
  }
}

Prerequisites

A working local setup, see Getting Started.

Setup

Site identity

ts
metadata: {
  name: '<your-site-name>',                              // site name, used in titles and OG tags
  images: {
    ogImage: '/logo.png',                          // social share image (1200×630)
    logoLight: '/logo-horizontal-transparent.svg', // light-theme wordmark
    logoDark: '/logo-horizontal-dark.svg',         // dark-theme wordmark
    icon: '/icon-jerboa.svg',                      // favicon
  },
}

See Design System for how the logo is rendered.

What the homepage sells

ts
landingOffer: {
  productId: 'template',
  offerId: 'once',
}

Pricing is shown in the homepage #pricing section. The old /pricing URL redirects to that section in the current language and no longer shows the demo plan page.

productId is the id declared in src/config/products.ts. template is only a historical name — rename it to whatever your product is called, in the config and in landingOffer alike.

The homepage uses the existing Checkout flow. productId / offerId select the one-time product's prices.once in src/config/products.ts; no external sales URL is needed. Set that value to the Stripe lookup_key of a one-time price you created — the amount lives only in Stripe, never in the code.

No amount is stored in config: the Stripe price catalog is the single source of truth, read by both the homepage display and checkout. The server only verifies the price is mode: 'payment' and denominated in USD — if the lookup_key points at a subscription price, checkout is rejected rather than silently selling the wrong thing.

Enable auth.enabled and payment.enabled. Guests sign in or register first, with the return path preserved through email verification. They return to the homepage pricing section to continue purchasing. Cancelling Checkout returns there too; successful payments return to billing, with payment records confirmed by the existing webhook. “See how to start” links to the current language’s docs, falling back to features when docs are disabled.

Theme

ts
ui: {
  defaultTheme: 'system',      // 'light' | 'dark' | 'system'
  enableThemeSwitch: true,     // show the toggle in the navbar
  themeColor: {                // browser chrome and PWA background
    light: '#FCFAFF',
    dark: '#0A0A0F',
  },
}
themeColor must match --background in styles/globals.css. These values render outside the page and cannot read CSS variables, so they must be declared here. tests/unit/theme-colors.test.ts asserts equivalence — change both together.

Module switches

Every optional module has enabled. When off, its pages 404, its API returns 404 MODULE_DISABLED, and navigation entries hide themselves.

ts
docs: { enabled: true },
blog: { enabled: true },
changelog: { enabled: true },
mail: { enabled: true, provider: 'resend', supportEmail: '<your-support-email>' },
contact: { enabled: false },
newsletter: { enabled: false, provider: 'resend' },
payment: { enabled: true, provider: 'stripe', /* … */ },
notification: { enabled: false, provider: 'discord' },
analytics: { enabled: true, providers: ['ga'] },
auth: { enabled: true, requireEmailVerification: true },
FieldDefaultNotes
docs / blog / changelogtrueContent modules, pages already exist
mailtrueTransactional email. supportEmail feeds a mailto: entry
contactfalseContact form
newsletterfalseEmail subscriptions
paymenttrueStripe checkout and billing page
notificationfalseDiscord / Feishu webhooks
analyticstrueAnalytics scripts; requires VITE_GA_ID when enabled
authtrueSign-in and registration; off means the whole auth path 404s
auth.requireEmailVerification is a security control, not an email switch, and currently defaults to true. Resend mail is also enabled: configure RESEND_API_KEY and a plain MAIL_FROM address on a verified domain. Required verification with incomplete mail makes auth report incomplete, the auth API return 503, and pnpm check:env:prod fail. Verification is never implicitly disabled. supportEmail is <your-support-email> and is independent of MAIL_FROM; see Authentication and Email.

Feature switches

ts
features: {
  enableI18n: true,        // zh / en
  enableFileUpload: false, // uploads (needs R2)
  enableApiKeys: true,     // self-service API keys
  enableAdmin: true,       // admin dashboard
  enableAIGateway: false,  // AI gateway
}
ts
social: {
  github: 'https://github.com/your-org/your-repo',
  x: 'https://x.com/your-handle',
}

Only valid HTTPS URLs without credentials are rendered. Supported platforms are listed in the WebsiteConfig['social'] type.

References

What's next