This guide documents Lunet from a user perspective: how to create a site, configure it, and use each built-in module.
| Guide | What you'll learn |
|---|---|
| Getting started | Install Lunet, create a site, and run lunet build/lunet serve |
| CLI reference | init, clean, build, serve and their options |
| Site structure | What lives in your site folder and what Lunet generates under .lunet/ |
| Guide | What you'll learn |
|---|---|
Configuration (config.scriban) |
How the config script runs and how to use Scriban to drive builds |
| Content & front matter | Pages vs static files, YAML vs +++ Scriban front matter, common page variables |
| Layouts & includes | Layout resolution in /.lunet/layouts, includes in /.lunet/includes |
| Themes & extensions | extend "owner/repo@tag", layering rules, conventions (dist/, .lunet/) |
| Guide | What you'll learn |
|---|---|
| GitHub Actions | Build and publish your site to GitHub Pages with a single workflow file |
| Module | What it does |
|---|---|
| Extends (themes) | Download + layer themes/extensions |
| Resources (npm) | Download + cache external assets |
| Bundles | Build CSS/JS bundles and copy content |
| Markdown | Convert Markdown to HTML (+ xref support) |
| SCSS (Dart Sass) | Compile SCSS to CSS |
| Minifier | Minify JS/CSS (used by bundles) |
| Summarizer | Compute page.summary for feeds/cards |
| Menus | Define navigation via menu.yml |
| Taxonomies | Tags/categories + generated term pages |
| RSS | Generate RSS feeds via layouts |
| Sitemaps | Generate sitemap.xml + robots.txt |
| Search | Generate a client-side search index |
| Cards (OpenGraph/Twitter) | SEO/social meta tags |
| Tracking (Google Analytics) | Analytics injection (prod only) |
Server (lunet serve) |
Local web server + live reload |
Watcher (--watch) |
File watcher + incremental rebuild |
| Data modules overview | Supported data formats at a glance |
| Datas | Load data files from /.lunet/data into site.data |
| YAML | YAML front matter + YAML data loading |
| JSON | JSON data loading |
| TOML | TOML data loading |
| Attributes (URL patterns) | Apply per-path metadata like url patterns |
| API | API-documentation registry (site.api) |
| API (.NET) | Generate .NET API docs from projects/assemblies |
docs/todos/ and are marked as discard: true.