Search documentation...

Quick Start

Get up and running with Velt in minutes.

Create a New Project

./velt new my-website
cd my-website

This creates a new Velt project with the following structure:

my-website/
β”œβ”€β”€ content/
β”‚   └── index.vdx
β”œβ”€β”€ layouts/
β”‚   └── default.v
β”œβ”€β”€ components/
β”‚   └── callout.v
└── assets/
    └── style.css

Start Development Server

../velt dev

Open http://localhost:3000 in your browser.

The dev server includes live reload - changes are reflected instantly!

Create Your First Page

Create a new file content/about.vdx:

+++
layout = "default"
title = "About"
+++

# About Us

Welcome to our website built with Velt!

The page will automatically appear in the navigation.

Build for Production

../velt build

This generates static HTML files in the dist/ directory, ready for deployment.

Next Steps