Proton

A CLI tool for compiling web pages into static HTML. Lightweight, fast, and focused — Twig templates, Markdown, YAML data, and nothing else.

Getting Started

Create your first site in under a minute.

Templates

Layouts, pages, partials, and macros with Twig.

Data

YAML and JSON data files with front matter.

Configuration

Customize paths, output, and layout rules.

Quick Start

# Install via Composer
composer global require foundation/proton # Create a new site
proton init --config # Build
proton build # Watch with live reload
proton watch

Philosophy

Proton handles one thing: compiling templates into HTML. It does not manage CSS, JavaScript, or assets — those are your responsibility. Use whatever build tools you prefer alongside Proton.

  • Zero NPM conflicts — built with PHP, so its dependencies stay completely outside your project's NPM chain
  • Twig templating — layouts, partials, macros, inheritance
  • Markdown pages — write content in Markdown, compile to HTML
  • YAML/JSON data — global and per-page data files
  • Live reload — auto-refresh browser during development
  • Batch pages — generate multiple pages from data arrays
  • Sitemap — auto-generated sitemap.xml