Nuxas Documentation

Everything you need to know, from purchase to deployment. Written for developers of all experience levels.

Getting Started

Welcome to Nuxas

A warm, beginner-friendly introduction to Nuxas, the production-grade Nuxt 4 SaaS template. Learn what it is, who it is for, and what you will find in this documentation.

Purchase

How to Purchase Nuxas

A complete, beginner-friendly guide to the two Nuxas editions — Code Only and Code + Decap CMS — including what each edition includes, how much it costs, and where to buy it.

Getting Started

What to Do After You Purchase

A complete, beginner-friendly guide to what happens after you buy Nuxas. Learn how to download your files, install the tools you need on Windows, and prepare your computer for development.

Getting Started

Installing and Running Nuxas Locally

A complete, beginner-friendly guide to installing Nuxas dependencies and running the project on your computer for the first time. Includes troubleshooting for common Windows issues.

Configuration

Initial Configuration — Setting Your Project URL

A complete, beginner-friendly guide to configuring Nuxas for your own domain. Learn how to edit nuxt.config.ts, understand environment variables, and prepare the project for deployment.

Configuration

Understanding the Project Structure

A complete, beginner-friendly tour of the Nuxas project structure. Learn what each folder does and where to find the files you will edit most often.

Decap CMS

Running Nuxas with Decap CMS Locally

A complete, beginner-friendly guide to running Nuxas with Decap CMS on your own computer. Learn how to start two terminals, connect the CMS to your project, and edit content from the browser.

Content Editing

Global Site Config — Navbar, Footer, and Homepage

A complete, beginner-friendly guide to editing the global site configuration in Nuxas. Learn how to update your navbar, footer, homepage hero, social proof, features, steps, pricing, testimonials, and call-to-action sections through Decap CMS or by editing site.yml directly.

Content Editing

Page Configs — Blog and Product Listing

A complete, beginner-friendly guide to configuring the blog list page and the product list page in Nuxas. Learn how to set page titles, headings, intros, and page sizes through Decap CMS or by editing YAML files directly.

Content Editing

Setting Up the Contact Page with Formspree

A complete, beginner-friendly guide to setting up the contact form in Nuxas. Learn how to create a Formspree account, get your form ID, and connect it to your site through Decap CMS or by editing files directly.

Content Editing

Customizing the 404 Error Page

A complete, beginner-friendly guide to customizing the 404 error page in Nuxas. Learn how to edit the error message, the heading, and the return links through Decap CMS or by editing the 404.md file directly.

Content Editing

Managing Blog Posts

A complete, beginner-friendly guide to creating, reading, updating, and deleting blog posts in Nuxas. Learn every frontmatter field, how to write the body in Markdown, and how to manage posts through Decap CMS or by editing files directly.

Content Editing

Managing Products

A complete, beginner-friendly guide to creating, reading, updating, and deleting products in Nuxas. Learn every frontmatter field, how to add gallery images, and how to connect each product to a purchase URL.

Content Editing

Managing Static Pages

A complete, beginner-friendly guide to creating, reading, updating, and deleting static pages in Nuxas. Learn how to add About pages, Privacy policies, Terms of Service, and any other page your site needs.

Deployment

Pre-Push Checklist Before Going Live

A complete, beginner-friendly checklist to review before you push your Nuxas project to GitHub and deploy it to production. Catch broken links, missing images, and configuration mistakes before your visitors do.

Deployment

Pushing Your Code to GitHub

A complete, beginner-friendly guide to creating a GitHub account, setting up a repository, and pushing your Nuxas project from your local computer to GitHub. Includes Personal Access Token setup and Decap CMS OAuth preparation.

Deployment

Deploying to Netlify

A complete, beginner-friendly guide to deploying your Nuxas project to Netlify. Learn the difference between SSG and SSR builds, connect your GitHub repository, configure the build settings, enable Netlify Identity, and activate Git Gateway for Decap CMS in the cloud mode.

Deployment

Deploying to Other Hosting Providers

A complete, beginner-friendly guide to deploying your Nuxas project to Cloudflare Pages, Vercel, AWS Amplify, cPanel shared hosting, and a VPS. Learn the difference between SSG and SSR builds, and the exact build commands, presets, and platform-specific configurations for each.

Deployment

Setting Up a Custom Domain

A complete, beginner-friendly guide to connecting your own domain name to your deployed Nuxas site. Learn how to buy a domain, configure DNS records, and enable HTTPS on Netlify, Cloudflare, Vercel, and other hosting providers.

Support

Support and Services

How to get help with Nuxas, whether through the built-in contact form, direct email, or professional services. Includes response times, what we can help with, and how to book custom work.