Velt Documentation

Welcome to the official documentation for Velt - a type-safe, zero-runtime JS static site generator built with V.

Velt is currently in active development. APIs might change.

What is Velt?

Velt is a modern static site generator that combines:

Type-safe templates - Layouts and components written in V
Zero runtime JS - Pure static HTML output
Blazingly fast - V's compilation speed
Live reload - Instant updates during development

Getting Started

New to Velt? Start here:

Installation - Set up Velt on your system
Quick Start - Create your first project
Project Structure - Understand the file layout

Guides

Learn how to use Velt effectively:

Layouts - Customize your site's HTML structure
Components - Create reusable building blocks
Styling - Style your site with CSS

Reference

Detailed technical documentation:

CLI Reference - All available commands
Frontmatter - Page metadata options

Features

VDX Files

Mix Markdown with V components:

# Hello World

<Callout type_="info">
This is rendered by a V component!
</Callout>

Auto Navigation

Sidebar navigation is generated automatically from your content files. Subdirectories become collapsible sections.

Dark Mode

Built-in dark mode support with localStorage persistence.

Support

GitHub Issues - Report bugs
GitHub Discussions - Ask questions