Quickstart

Generate your first site in two commands.

Install

cargo install --path yoshi-cli

Generate

yoshi generate ./blueprint --out ./site
cd ./site && pnpm install && pnpm build

That's it — a complete, static, buildable site in site/out/, ready to deploy to any static host (Cloudflare Pages, Netlify, S3). pnpm dev runs it locally for a look.

What just happened

generate ran a short pipeline:

  1. Data — rendered products.ts, cities.ts, site-config.ts, … from your blueprint JSON.
  2. Skeleton — composed the shared core with the chosen type layer (see Site Types).
  3. Brand — synthesised a logo if you didn't provide one; staged your matched photos.

For a docs site ("siteType": "docs" in config.json) the data/brand steps are skipped — the content is markdown, and the pipeline generates the docs content + nav from a content/*.md directory.