Publish Compass

Publishing Compass is mostly about replacing the sample project details, verifying the production build, and checking that the generated site behaves the way you expect.

Update the public-facing settings

Before publishing, review site.config.mjs and make sure these values are yours:

• siteUrl
• name
• title
• description
• githubUrl
• navCtaLabel
• navCtaHref
• footerText

These settings affect metadata, navigation labels, links, and canonical URLs.

Test the production build locally

Search is generated during the build step, so it is worth testing the production output instead of relying only on the dev server.

Run:

npm run build
npm run preview

Use that preview to confirm:

• the homepage sections look correct
• category and article routes load
• search returns results
• metadata-driven content such as titles and descriptions appears correctly

Check your content structure

Before going live, make sure:

• sample articles you do not want are removed or rewritten
• category names in src/data/docs.ts match your real information architecture
• article ordering feels intentional
• links between articles still make sense after any renames

Review assets and branding

Compass ships with default icons and social assets. Replace the ones you want to own before publishing:

• public/favicon.svg
• public/favicon-light.svg
• public/favicon-dark.svg
• public/og-image.png

Final pre-publish checklist

• Build succeeds with npm run build
• Search works in npm run preview
• site.config.mjs uses real URLs
• Sample docs have been replaced
• Branding assets are updated

After that, Compass is ready to deploy as a static site on the hosting platform you prefer.