What Is Metadata?
The data/metadata.yaml file controls site-wide settings that appear on every page: your site title, description, navigation links, footer columns, and social media handles. This is the first thing you should configure after installing Luax Pro.
Via Decap CMS
1. Open http://localhost:8080/admin/ in your browser
2. Click Site Settings in the left sidebar
3. Click Metadata
4. Edit the fields:
| Field | What It Controls |
|---|---|
| URL | Your production domain (e.g., https://luaxpro.axcora.com) |
| Title | Site name shown in browser tabs and Open Graph |
| Description | Meta description for SEO and social sharing |
| Image | Default Open Graph image path (e.g., /images/luax-logo.webp) |
| Favicon | Favicon path (e.g., /images/luax-logo-transparent.png) |
| Twitter User | Your Twitter/X handle (e.g., @luaxpro) |
5. Scroll down to Navbar to edit your site name initial, title, and menu links
6. Scroll down to CTA to edit the call-to-action band that appears on most pages
7. Scroll down to Footer to edit your footer columns
8. Click Publish when done
Via Code
If you prefer to edit the file directly, open data/metadata.yaml in your text editor:
url: https://luaxpro.axcora.com
title: Luax Pro - Lua Static Site Generator
description: Premium Lua static site generator with Decap CMS. One-time $145.
image: /images/luax-logo.webp
favicon: /images/luax-logo-transparent.png
twitter_user: "@luaxpro"
navbar:
initial: LX
title: Luax Pro
list:
- title: Home
url: /
- title: Demo
url: /home/
- title: Blog
url: /blog/
- title: Pricing
url: "#pricing"
- title: Contact
url: /contact/
cta:
title: Ready to Ship Faster with Pure Lua?
description: One-time $145. No subscription. Free lifetime updates.
btn:
text: Buy Luax Pro Now
url: https://creativitaz.gumroad.com/l/luaxpro
footer:
nav1:
info: LX
description: Premium Lua static site generator with Decap CMS.
nav2:
title: Product
list:
- title: Live Demo
url: /home/
- title: Blog
url: /blog/
nav3:
title: Resources
list:
- title: Documentation
url: /docs/
- title: GitHub
url: https://github.com/mesinkasir/luax
nav4:
title: Connect
list:
- title: Support
url: mailto:[email protected]
copyrights: Luax Pro by Axcora.
copyrights2: One-time $145. No subscription.
Field Reference
url — The full domain where your site will live. Used in sitemap, RSS, and canonical URLs.
title — The site name. Appears in browser tabs and as the Open Graph site name.
description — A one-sentence description. Used in meta tags and social sharing previews.
image — Path to your default social sharing image. Recommended size: 1200x630 pixels.
favicon — Path to your favicon. Can be .png, .webp, or .ico.
twitter_user — Your Twitter/X handle for Twitter Card attribution.
navbar.list — Array of navigation links. Each item needs a title and url. For anchor links within a page, use #section-id.
footer.nav1 through nav4 — Footer columns. Each column has a title and a list of links.
Widget Labels
Luax Pro lets you rename the labels that appear on service detail pages, project detail pages, and blog post pages. Every label is controlled from data/metadata.yaml under the widget key. You do not need to edit templates to change these labels.
Via Decap CMS
1. Open http://localhost:8080/admin/
2. Click Site Settings → Metadata
3. Scroll down to the Widget section
4. Expand the group you want to edit: Projects, Services, or Blog
5. Change any label field
6. Click Publish
Via Code
Open data/metadata.yaml and add or edit the widget block:
widget:
projects:
title: Service Specs
cta1_button: Build Similar System
cta1_url: /contact/
cta2_button: Back to Projects
cta2_url: /projects/
highlight: Engineering Highlights
implementation: Luau Implementation Excerpt
gallery: Environment Gallery
next: Next Project
prev: Previous Project
genre: Genre
partner: Partner
role: Role
visits: Visits
ccu: Peak CCU
retention: Retention
stack: Tech Stack
services:
title: Service Specs
deliverables: Included Deliverables
faq: Service FAQ
pricing: Milestone Pricing Tiers
cta1_button: Request Proposal
cta1_url: /contact/
cta2_button: Back to Services
cta2_url: /services/
next: Next Service
prev: Previous Service
blog:
title: Need This Implemented?
desc: We apply these exact optimization, ProfileStore, and security patterns directly inside client games.
line_code: Production Luau Reference
cta1_button: Hire LuaxBlox
cta1_url: /contact/
cta2_button: All Articles
cta2_url: /posts/
prev: Previous Article
next: Next Article
Field Reference
widget.projects.title — Heading above the project specification list on the project detail sidebar.
widget.projects.cta1_button — Text for the primary button on the project sidebar. Default target is /contact/.
widget.projects.cta2_button — Text for the secondary button. Default target is /projects/.
widget.projects.highlight — Heading above the engineering highlights list.
widget.projects.implementation — Heading above the code excerpt window.
widget.projects.gallery — Heading above the environment gallery grid.
widget.projects.next and prev — Labels for the previous and next project navigation at the bottom of the detail page.
widget.projects.genre, partner, role, visits, ccu, retention, stack — Labels for each row in the project specification list.
widget.services.title — Heading above the service specification list.
widget.services.deliverables — Heading above the included deliverables list.
widget.services.faq — Heading above the service FAQ accordion.
widget.services.pricing — Heading above the milestone pricing tiers.
widget.services.cta1_button and cta1_url — Primary button label and target on the service sidebar.
widget.services.cta2_button and cta2_url — Secondary button label and target.
widget.services.next and prev — Labels for adjacent service navigation.
widget.blog.title — Heading for the hire box that appears at the bottom of each blog post.
widget.blog.desc — Description text inside the hire box.
widget.blog.line_code — Heading above the code reference window in blog posts.
widget.blog.cta1_button and cta1_url — Primary button label and target in the blog hire box.
widget.blog.cta2_button and cta2_url — Secondary button label and target.
widget.blog.prev and next — Labels for previous and next article navigation.
Docs Sidebar
The docs sidebar is the navigation panel that appears on the left side of every documentation page. It controls which links appear, in what order, and under which group headings.
You have two ways to control the docs sidebar:
Option 1 — Manual sidebar (recommended for Docusaurus-style ordering). Set docs_use_sidebar: true in data/metadata.yaml and define your links in docs_sidebar. The /docs/ landing page will render cards in the exact order you list them. The sidebar on detail pages uses the same order.
Option 2 — Automatic listing. Set docs_use_sidebar: false. The /docs/ landing page will list every file in src/docs/ alphabetically by filename. No manual ordering. The sidebar on detail pages will be empty unless you also define docs_sidebar.
Via Decap CMS
1. Open http://localhost:8080/admin/
2. Click Site Settings → Metadata
3. Scroll down to Docs Use Sidebar — toggle on for manual ordering, toggle off for automatic listing
4. Scroll down to Docs Sidebar to add, remove, or reorder links
5. Each sidebar group has a Title and a List of items. Each item has a Title and a URL
6. Click Publish
Via Code
Open data/metadata.yaml:
docs_use_sidebar: true
docs_title: LuaBlox Docs
docs_sidebar:
- title: Getting Started
items:
- title: Why Lua SSG
url: /docs/01-welcome/
- title: Install Lua 5.4
url: /docs/02-installation/
- title: Download Luax Pro
url: /docs/03-download-luax/
- title: Site Configuration
items:
- title: Update Site Metadata
url: /docs/07-update-metadata/
- title: Update Homepage
url: /docs/08-update-home/
How the Flag Works
docs_use_sidebar: true — The /docs/ landing page reads docs_sidebar and renders one card per item, in the order you define. Cards show the title and the description from docs_sidebar items. Numbered automatically by the browser script.
docs_use_sidebar: false — The /docs/ landing page ignores docs_sidebar and instead loops every file in src/docs/, sorted alphabetically by filename. Useful when you do not want to maintain a manual list.
The detail pages always read docs_sidebar for the left navigation panel. If docs_sidebar is empty, the panel shows nothing. So even with docs_use_sidebar: false, you should keep docs_sidebar populated if you want navigation on detail pages.
Field Reference
docs_use_sidebar — Boolean. true for manual ordering, false for automatic listing.
docs_title — Optional heading used by the docs layout. Falls back to the controller title if empty.
docs_sidebar — Array of groups. Each group has a title and an items array. Each item has a title and a url. Add description to items if you want the landing page cards to show a summary.
Naming Convention for Docs Files
The example sidebar above uses numbered filenames like 01-welcome.md, 02-installation.md, 03-download-luax.md. This numbering forces the automatic listing (docs_use_sidebar: false) to appear in the same order as your manual sidebar. If you do not use numbering, the automatic listing will be alphabetical: installation before welcome, which may not match your intended flow.
You can also use numbered filenames with docs_use_sidebar: true — the numbers make no difference when manual ordering is enabled, but they keep both modes consistent.
After Updating
Save the file (or click Publish in Decap CMS). If the Luax dev server is running, it rebuilds automatically. Refresh your browser to see the changes.
Next Step
Metadata is configured. The next guide covers updating your homepage content in src/index.md.