Quick start
npm install
npm run dev # http://localhost:4321
npm run build
npm run check # TypeScript check
The dev server opens a placeholder home page (src/pages/index.astro). Additional pages:
/internal— component playground (InternalLayout)/docs/...— this docs section (rendered fromsrc/content/docs/)/guidebooks/style-guide,/component-guide,/table,/entity-stack-2— UI block showcase
Forking
- Create a new repo from this template via GitHub UI or:
gh repo create your-org/your-site --template epoch8/astro-website-template --private - Open
src/config/site.ts— replace name, domain, colors, contact links. - Replace assets in
public/:favicon.svg,og-image.png,logo.svg. - Set up deploy (see
docs/forking.mdfor GitHub Pages / Vercel / Cloudflare recipes).
Project structure
src/
├── config/site.ts ← brand config (edit this when forking)
├── layouts/ ← BaseLayout, DocsLayout, InternalLayout
├── components/
│ ├── blocks/ ← reusable UI blocks
│ └── products/template ← default logo
├── content/
│ ├── docs/ ← markdown docs (this section)
│ └── template/ ← navigation, SEO, sample data
├── pages/
└── styles/
See CLAUDE.md in the repo root for the full architecture reference.