Getting Started with LUAX SSG
A simple guide to start using LUAX static site generator.
LUAX SSG
Static Site Generator built with Lua. Fast, lightweight, and modern.
LUAX is a lightweight, fast, and modern static site generator built with Lua. It uses the LAX template engine to generate static websites from Markdown content with YAML frontmatter.
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
Markdown
Write content in Markdown
YAML
Write configuration and setup in YAML data
TAGS
Automatic tags article blog posts
Fast
luax build - Builds in milliseconds
Assets
Automatic public assets copying
Why Lua?
Lua is a lightweight, fast, and embeddable scripting language. It's perfect for building CLI tools like static site generators because:
- Fast execution - Lua is one of the fastest scripting languages
- Small footprint - No heavy dependencies or package managers
- Portable - Runs on Windows, Linux, and macOS
- Simple syntax - Easy to learn and modify
Why Lua?
- Fast execution - Lua is one of the fastest scripting languages
- Small footprint - No heavy dependencies or package managers
- Portable - Runs on Windows, Linux, and macOS
- Simple syntax - Easy to learn and modify
The Concept
LUAX follows the same concept as popular SSGs like Jekyll, Hugo, and 11ty:
- Content - Write in Markdown with YAML frontmatter
- Templates - Use LAX template engine for layouts
- Build - Generate static HTML files
- Deploy - Host anywhere
Why Choose LUAX?
- Markdown - Write content in Markdown
- Tags - Automatic tag pages
- Pagination - Blog posts pagination
- SEO - Open Graph, JSON-LD, sitemap, RSS
- Assets - Automatic public assets copying
- Fast - Builds in milliseconds
- Simple - Easy to customize
Built for Simplicity
LUAX was created to make static site generation simple and accessible. No complex configurations, no heavy dependencies, no steep learning curve. Just Lua and Markdown.
🚀 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.
Latest Posts
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.