Skip to content

varavelio/veta

Repository files navigation

Veta

CI status Release Version License

A Varavel project

Veta is a static site generator that combines JavaScript page generators, templates, arbitrary data sources, components, filters, Markdown rendering, themes, and embedded Tailwind CSS into a single binary and easy to use CLI.

Installation

Select the method that best fits your workflow.

Platform Method Command
Linux / macOS Shell curl -fsSL https://get.varavel.com/veta | sh
Linux / macOS Homebrew brew install varavelio/tap/veta
Windows PowerShell irm https://get.varavel.com/veta.ps1 | iex
Any NPM (local) npm install --save-dev @varavel/veta
Any NPM (global) npm install --global @varavel/veta
Any Docker docker run --rm varavel/veta
Any Manual Download binaries

For version pinning, prereleases, npm usage, and manual installs, see the complete installation guide.

Usage

Create a starter project:

veta init my-site

Build a site from the current project:

veta build

Start the local development server with live reload:

veta dev

Build with an explicit config file:

veta build --config path/to/veta.yaml

Project Structure

Veta projects can contain:

  • veta.yaml for tool configuration.
  • data/ for JSON, YAML, TOML, or JavaScript data files.
  • pages/ for flat JavaScript page generator files.
  • templates/ for Pongo2 page templates.
  • components/ for reusable component templates.
  • filters/ for JavaScript filters.
  • public/ for static assets copied to the output directory.

About

A friendly, single-binary static site generator built in Go with DX at its core

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors