Skip to content
@jordanlee
documentation

Getting Started

Configuration

Every site-level setting lives in one file: src/config/site.ts.

on this page

The config file

src/config/site.ts exports a single siteConfig object. It is fully typed, so your editor will tell you what every field expects.

src/config/site.ts
export const siteConfig: SiteConfig = {
name: '@jordanlee', // header + metadata
title: 'Jordan Lee', // homepage <title>
description: '…', // default meta description
url: 'https://example.com',
locale: 'en_US',
colorScheme: 'dark', // 'dark' | 'light' | 'system'
// …
};

Author

author: {
name: 'Jordan Lee',
email: 'hello@example.com',
avatar: '/images/avatar.jpg',
info: [
'Designer & writer',
'Ex-[Studio Nord](https://example.com)',
'Lisbon',
],
},

info entries are shown in one line under your name on the homepage, separated by dots. They accept inline Markdown links, code, and bold.

social: [
{ name: 'Instagram', icon: 'instagram', href: 'https://instagram.com/…' },
{ name: 'Email', icon: 'mail', href: 'mailto:hello@example.com' },
],

Order is display order. Available icons: instagram, bluesky, linkedin, twitter, mastodon, youtube, dribbble, github, facebook, threads, tiktok, twitch, discord, telegram, whatsapp, reddit, medium, substack, pinterest, behance, spotify, gitlab, stackoverflow, codepen, globe, mail, rss.

navigation: [
{ label: 'Posts', href: '/posts' },
{ label: 'CV', href: 'https://example.com/cv.pdf' },
],

Internal paths are prefixed with the base path automatically; absolute URLs open in a new tab.

Homepage sections

home: {
recentPosts: 4, // 0 hides the section
featuredProjects: 2, // 0 hides the section
},

Featured projects are those with featured: true in their frontmatter; when none are marked, the first projects by order are used.

Posts

posts: {
postsPerPage: 10,
rssFullContent: true, // include rendered HTML in /rss.xml
},
footer: { since: 2024, text: null, credit: true },
theme: { purchaseUrl: null, purchaseLabel: 'Get this theme' },
analytics: {
cloudflareToken: null, // Cloudflare Web Analytics
googleAnalyticsId: null, // GA4 measurement id
},

since sets the first year of the copyright range and text adds a line after it (a licence notice, say). theme.purchaseUrl is for the theme’s own demo site — when set it adds a “Get this theme” button to the header; leave it null on your site.

Feature flags

features: {
posts: true,
projects: true,
docs: true,
tags: true,
starfield: true, // animated starfield behind the page
halftone: true, // faint screentone overlay
colorSchemeToggle: true,
footer: true,
},

Turning a section off removes its routes from the build. Remember to remove it from navigation as well.