Getting Started with LUAX SSG
A simple guide to start using LUAX static site generator.
LUAX SSG v1.2
Blazing fast static site generator built with Lua + LAX. Now with versioned docs support v0.3, dot-folder fix & pretty URL router.
LUAX v1.2 is here - lightweight, fast, and modern static site generator built with Lua. Now supports versioned documentation like /v0.3/about/, /v1.2/docs/ with full pretty URL and Windows dot-folder fix.
Terminal
$
git clone https://github.com/mesinkasir/luax.git
$
luax build
✨ Build complete! 7 posts generated
$
luax start
✓ Server started at port 8080
🌐 http://localhost:8080
SEO
Meta Tags, Open Graph, JSON-LD, sitemap, RSS, robots.txt
Markdown
Write content in Markdown with TOC, FN
YAML
Powerful YAML frontmatter & data folder
TAGS
Automatic tags + versioned collections
Fast
luax build - Builds 15 files in 1.3s
Versioning
Native support for /v0.3/, /v1.2/, /v.03/ docs
What's New in v1.2?
LUAX v1.2 rebuilt for versioned documentation and pretty URL stability
- Versioned Docs - Full support for /v0.3/about/, /v1.2/docs/, /v.03/ with dot in folder name
- Dot-Folder Fix - Fixed Windows dir /b bug for folders like v0.3, v1.2, v.03
- Pretty URL Router - New router.php fixes /about/ vs /about/index.html on localhost
- PHP Priority Server - start.lua now prioritizes PHP + router.php over Python
What Makes LUAX v1.2 Different?
- Versioning Native - No plugin needed for /v0.3/, /v1.2/
- Pure Lua - No JavaScript, no Ruby, no Python needed for build
- Dot-Safe - Works with v0.3, v1.0, v.03, v2.5 folder names
- Pretty URL Fixed - router.php handles /about/ correctly
The Concept
LUAX follows the same concept as popular SSGs like Jekyll, Hugo, and 11ty, but with versioning power
- Content - Write in src/v0.3/about.md -> /v0.3/about/
- Versioning - Create src/v1.2/, src/v0.3/ for multi-version docs
- Templates - Use LAX template engine for layouts
- Build - Generate static HTML with pretty URLs
Why Choose LUAX v1.2?
- Versioned Docs - /v0.3/about/, /v1.2/docs/ support
- Dot Folder - Support v0.3, v.03, v1.2 naming
- Markdown - Write content in Markdown
- Tags - Automatic tag pages
- Pagination - Blog posts + versioned pagination
- SEO - Open Graph, JSON-LD, sitemap, RSS
- Router - PHP router.php for perfect pretty URLs
- Fast - Builds in milliseconds
- Simple - Easy to customize
Built for Versioned Docs
LUAX v1.2 was created to make versioned documentation simple. No complex configs, no heavy dependencies. Just create src/v0.3/about.md and it becomes /v0.3/about/. Perfect for changelogs, API docs, and multi-version sites.
🚀 Built with ❤️ using LUAX
Get Started
git clone https://github.com/mesinkasir/luax.git
cd luax
luax build
luax start
Your site is now running at http://localhost:8080
Upload dist/ folder in to your hosting or build using github action, Delpoy on Cpanel, VPS, Vercel, Cloudflare, Netlify, or Github Pages.
Blog
Why Lua is Great for Static Sites
Lua is lightweight, fast, and perfect for building static site generators.
Understanding LAX Template Engine
Learn the basics of LAX template engine used in LUAX.
Writing Content with Markdown and YAML
How to write content using Markdown with YAML frontmatter in LUAX.
Deploying LUAX Sites
Learn how to deploy your LUAX site to production.
SEO with LUAX
LUAX automatically generates SEO-friendly metadata.
Support Luax
If you find LUAX helpful, consider supporting us.