Getting Started with AstroWEBTheme
Documentation

Getting Started with AstroWEBTheme

Install the theme, run your first build and find the files you are meant to edit.

Getting Started with AstroWEBTheme

AstroWEBTheme is an Astro theme with a clear boundary between reusable internals and project-owned files. This page takes you from a fresh checkout to a first build.

Install

Use the package manager declared in package.json (pnpm). The astroweb CLI prints a plan first and changes nothing until you ask it to.

pnpm install
astroweb install          # dry-run plan
astroweb install --apply  # only after reviewing the plan

Run and build

pnpm run dev
pnpm run build
pnpm exec astro check

dev and build run prebuild steps that regenerate CSS, JavaScript, manifests, search data, service worker assets and Cloudflare configuration. Do not edit those generated files by hand.

Where to edit

  • src/site/content/ for MDX and JSON content.
  • src/site/config/ for site configuration, navigation, collections and security.
  • src/site/styles/ for project styling.
  • src/components/ and src/layouts/ for project overrides.

Treat core/ with extra care. Core updates arrive as a reviewed plan; see Theme Updates and Core Boundaries.

Next steps

  1. Read Configuration to set up navigation and collections.
  2. Follow the Cloudflare Deployment Checklist when you are ready to deploy.
  3. If a coding agent is helping, start with Installing With an AI Agent.