Getting started with vagejs

terminal

npm create vagejs@latest my-site
cd my-site
npm install
npm run dev

Open the URL the dev server prints. Edit src/pages/index.md, save, and the browser reloads.

What you get

my-site/
├── src/pages/         every .md file is a page
├── src/layouts/       the HTML around each page
├── public/            files copied as-is (favicons, images)
├── vage.config.ts     site settings
├── AGENTS.md          instructions for AI coding agents
└── .github/workflows/ CI: check, build and audit on every push

Everyday commands

Command	What it does
`npm run dev`	Dev server with live reload
`npm run check`	Finds broken links, SEO and accessibility problems; writes nothing
`npm run build`	Writes the static site to `dist/`
`npm run audit`	Page-weight budgets and automated accessibility checks
`npm run preview`	Serves `dist/` the way a static host would

Before you deploy, set site in vage.config.ts to your real domain. vage check warns while it's still https://example.com.

Updating

terminal

npm outdated vagejs         # see what's available
npm update vagejs           # newest patch in your range
npm install vagejs@latest   # newest version; while vagejs is 0.x, read the release notes first

What you get

Everyday commands

Updating

Start with one command. You'll have a site running in a minute.

Start with one command.
You'll have a site running in a minute.