Nuxe is a Vue 3 meta-framework that layers opinionated conventions on top of Vue 3, Vite, and vue-router. It gives you server-side rendering, file-based routing, automatic component and composable imports, a flexible layout system, and per-pageDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/dvlkit/nuxe/llms.txt
Use this file to discover all available pages before exploring further.
<head> management — all configured and ready to use out of the box.
Introduction
Learn what Nuxe is, why it exists, and how its core features fit together.
Quickstart
Scaffold a new Nuxe app and have a working SSR project running in minutes.
Project Structure
Understand the file and directory conventions every Nuxe app follows.
Routing
File-based routing, dynamic segments, catch-all routes, and typed navigation.
Core Features
SSR
Server-side rendering with streaming support. Works in dev and production with no extra configuration.
Layouts
Declare a layout per page with
definePage. New layouts are discovered automatically.Auto-Imports
Components and composables are imported automatically — no manual import statements needed.
Data Fetching
useAsyncData and useFetch handle SSR hydration, lazy loading, and reactive refetching.Reference
Configuration
All
nuxe.config.ts options: port, API prefix, Vite config, and runtime config.CLI Reference
nuxe dev, nuxe build, nuxe start, and create-nuxe scaffold commands.Composables
Full API reference for every built-in composable exported by
@dvlkit/nuxe.Server API
Define server-side API routes in
server/api/ using h3 event handlers.