v0.0.3

Documentation version

Currently searching v0.0.3

Search pages, component props, utilities and tokens.

↑↓ to move to openesc to close

Open files in your editor

On a Mac, right-click the folder in Finder, hold Option, and choose Copy as Pathname.On Windows, hold Shift, right-click the folder, and choose Copy as path, then delete the quote marks.

GuidesLumos 0.0.1

Deploying

Turning the project into a folder of files, and putting it somewhere.

A Lumos site builds to plain HTML, CSS and images. There is no server to run and no database, which means it can be hosted almost anywhere, usually free.

Build it

bash
npm run build

This writes the finished site into a dist folder. To check it before it goes live, serve that folder locally:

bash
npm run preview

This is the real output, not the development server, worth a look before every deploy.

Set the URL first

Canonical URLs, the sitemap and social share images are all built from SITE_URL in src/consts.ts. If it still says the starter's address, every one of those will be wrong on the live site.

src/consts.ts
export const SITE_URL = "https://your-domain.com";

Your domain. The address the finished site will live at.

Where to put it

Any static host works. Cloudflare Pages, Netlify and Vercel all do the same thing: you connect the repository, they run npm run build on every push, and they publish the dist folder. Set the build command to npm run build and the output directory to dist.

This site is deployed as a Cloudflare Worker serving static assets, configured in wrangler.jsonc. That is one option among several, not a requirement.

Before you launch

  • SITE_URL, SITE_NAME and SITE_DESCRIPTION are yours, not the starter's.
  • A real og-image.jpg sits in public/, and social previews look right.
  • npm run check passes.
  • The favicon has been replaced.
  • Every page has a title and a description.
  • You have tabbed through the site once, and zoomed to 200% once.