Deploy your site

Recommended: GitHub Pages

The scaffolded --deploy github-pages mode writes a build.yml workflow that builds your site and deploys to GitHub Pages on every push to main.

1. Push the project to GitHub. Create a new repository and push.

   git remote add origin https://github.com/you/my-directory.git
   git push -u origin main

2. Enable GitHub Pages. Go to Settings → Pages. Set the source to GitHub Actions (not “Deploy from a branch”).

3. Watch the workflow run. Open the Actions tab. The Build workflow installs dependencies, runs pnpm build (which chains grove generate → grove sitemap → grove llms → astro build), and deploys.

4. Set a custom domain (optional). Add a CNAME file at the project root or use the Pages settings to wire up your domain.

The site is live at https://you.github.io/my-directory/ (or your custom domain).

Other providers

Vercel

grove new my-directory --deploy vercel

The scaffolder writes vercel.json and .github/workflows/deploy-vercel.yml. Push to GitHub, import the repo into Vercel, and the workflow triggers a Vercel deploy on every push to main.

Netlify

grove new my-directory --deploy netlify

Writes netlify.toml and .github/workflows/deploy-netlify.yml. Push and import into Netlify.

Cloudflare Pages

grove new my-directory --deploy cloudflare

Writes wrangler.jsonc and .github/workflows/deploy-cloudflare.yml. Push and import into Cloudflare Pages.

Any static host

If you run your own static host (S3 + CloudFront, Fastly, your own nginx), pick --deploy none and wire up your own CI. The build artifact is the dist/ directory produced by pnpm build — drop it anywhere that serves static files.

Continuous deploys

Every provider workflow runs on push to main. The validate-data.yml workflow runs on every pull request and blocks merge on schema errors. The sync-github-metadata.yml workflow runs on a schedule and on demand to refresh stars, licenses, and last-pushed dates.

Local preview before deploy

pnpm build
pnpm preview

The preview script serves the production build locally. Walk through every page, check every filter, click every link before you push.

Next steps

• Configure your space → — branding, theme, taxonomy.
• Community submissions → — accept new entries from contributors.