Skip to content

Spectara/Revela

Repository files navigation

Revela

Revela

Reveal your stories through beautiful portfolios

Modern static site generator for photographers — fast, beautiful output, no quality trade-offs. Built with .NET 10.

CI License: MIT .NET 10

🌐 revela.website — Documentation & Demo

Getting Started · Download · GitHub

Revela interactive menu


Note

Beta · active development, breaking changes possible. Versioned releases are available from GitHub Releases.


✨ Features

  • 🖼️ Modern Image Formats — JPEG by default, AVIF and WebP available with one config flag (off by default because they're CPU-heavy to encode). Responsive sizes and CSS-only LQIP placeholders included.
  • 🧙 Interactive Wizards — Project setup, theme picker, plugin install — no manual config files.
  • ** Plugin System** — Compress, Serve, Statistics, Calendar, Source.OneDrive, Source.Calendar.
  • 🎨 Themes — Lumina (+ Statistics and Calendar extensions). Customize via overrides instead of forking.
  • ⚡ Fast — Powered by libvips (NetVips), parallel processing, change detection.
  • 📊 Lighthouse-friendlyphoto.kirk.one (built with Revela) scores 100/100/100/100 with FCP 0.2 s, LCP 0.3 s, zero blocking time, zero layout shift.

🚀 Quick Start

1. Download & Run

Grab the Standalone build for your platform from the Releases page — a single self-contained binary, no .NET SDK needed.

  • Windows: unzip and double-click revela.exe
  • macOS / Linux: extract and run ./revela (or use the included launcher script)

The interactive wizard walks you through the rest.

2. Create a Project

The project wizard appears automatically and asks for:

  1. Project settings — Name and URL
  2. Theme selection — Choose your look
  3. Image settings — Default is JPEG only (AVIF and WebP can be flipped on later in project.json)
  4. Site metadata — Title, author, copyright

3. Add Photos

Create folders in source/ — folder names become gallery titles:

source/
├── 01 Weddings/
│   └── *.jpg
├── 02 Portraits/
│   └── *.jpg
└── 03 Landscapes/
    └── *.jpg

4. Generate

Select generateall from the menu (or run revela generate all):

Processing images [████████████████████] 100% 47/47
Rendering pages   [████████████████████] 100% 12/12

✓ Generation complete!

5. Preview

revela serve

Opens your browser with a live preview. The Serve plugin ships built-in with the Standalone build; for the modular Full / .NET Tool builds, install it once with revela plugin install Spectara.Revela.Plugins.Serve.


📦 Installation Options

Method Best For Where
Standalone Most users — single binary, all plugins built in Download
Full Want to add custom plugins, manage them via NuGet Download
.NET Tool You already have the .NET 10 SDK dotnet tool install -g Spectara.Revela
From Source Contributors See Setup Guide

Detailed Installation Guide →


🔌 Official Plugins

Standalone has all of these built in. Full / .NET Tool installs them on demand:

Plugin Description
Compress Pre-compress static files with Gzip/Brotli
Serve Local dev server with live preview
Statistics EXIF statistics page (camera bodies, lenses, focal lengths)
Calendar Calendar/timeline pages built from gallery dates
Source.OneDrive Import from OneDrive shared folders
Source.Calendar Import events from iCal feeds
revela plugin install Spectara.Revela.Plugins.Serve

And three theme packages: Lumina (default), Lumina.Statistics, Lumina.Calendar.


📖 Documentation

Visit revela.website/docs for the full documentation:

Offline/GitHub: docs/ folder contains the same documentation in Markdown.

🛠️ For Developers

git clone https://github.com/spectara/revela.git
cd revela
dotnet build
dotnet run --project src/Cli

Setup Guide →


🤝 Contributing

Contributions welcome! Please open an issue or pull request.

📄 License

MIT License

🙏 Acknowledgments

  • Expose by Jack Rugile — the original Bash-based static gallery generator that started this whole idea
  • Expose (fork) — the predecessor of this project, also Bash-based
  • libvips — image processing
  • Scriban — templates
  • CSS-only LQIP — blur placeholder technique by Lean Rada

About

Revela helps photographers create elegant websites to showcase their work with clarity and ease. The default theme is minimalist, placing images front and center. Lightweight and customizable.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors