Getting started with vagejs

terminal

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

Open the address 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 (a blog index is included)
├── src/layouts/       the HTML around each page
├── public/            files copied as-is (favicons, images)
├── vage.config.ts     site settings
├── links.lock.json    the websites your pages may link to
├── AGENTS.md          instructions for AI coding assistants
└── .github/           CI checks, dependency updates and an optional live-site check

Everyday commands

Command	What it does
`npm run dev`	Dev server with live reload
`npm run check`	Finds broken links, SEO, accessibility and spam problems; writes nothing
`npm run build`	Writes the finished 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 publish

Set site in vage.config.ts to your real domain. vage check warns while it's still https://example.com.
Run npm run check and fix every error.
Pick a host in Deployment.

Next: write your first pages.

Getting started
A working site in a minute.

What you get

Everyday commands

Before you publish

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

What you get

Everyday commands

Before you publish

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.